mobile icon indicating copy to clipboard operation
mobile copied to clipboard
verified publisher icon bitwarden

[EC-554] Document process to set up iOS local development

Open junyuanz1 opened this issue 3 years ago • 5 comments

Type of change

  • [ ] Bug fix
  • [ ] New feature development
  • [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
  • [ ] Build/deploy pipeline (DevOps)
  • [x] Other

Objective

I would love to contribute to the Bitwarden project in the future. I have spent several days trying to set up the iOS build environment, and to be honest; it is not as easy as said in the README.md file since several steps are required to make this runnable. Therefore, I am trying to add a section to the CONTRIBUTE.md file so that people can create the dev environment easily. I think this is a good fit for this section: https://contributing.bitwarden.com/clients/mobile/#ios-development

Code changes

None

Before you submit

  • [ ] I have added unit tests where it makes sense to do so (encouraged but not required)
  • [ ] This change requires a documentation update (notify the documentation team)
  • [ ] This change has particular deployment requirements (notify the DevOps team)

junyuanz1 avatar Jun 05 '22 20:06 junyuanz1

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Jun 05 '22 20:06 CLAassistant

Hi @junyuan-z, thanks for the writeup! We have internal instructions for iOS development, but they rely on having access to the Bitwarden team provisioning profiles & dev certificates, so we haven't made them public. It looks like you've gotten around this by changing the domain and generating your own profiles etc? Is there any other secret sauce in here to get it working without the 8bit provisioning profile?

If you can sign the CLA, I'll see if I can review and incorporate this into our new contributing site, https://contributing.bitwarden.com/. (not sure if this is strictly required but would make it easier)

eliykat avatar Jun 07 '22 22:06 eliykat

hi @eliykat, that's all the changes that I need to make. and I have signed the CLA but for some reason it still pending.

junyuanz1 avatar Jun 07 '22 22:06 junyuanz1

ok, CLA passed (need to make some change to my local git settings)

junyuanz1 avatar Jun 07 '22 22:06 junyuanz1

Thanks! I'm working through some other documentation work at the moment, but will add this to the list to update to contributing.bitwarden.com. I'll leave this PR open until then.

eliykat avatar Jun 09 '22 02:06 eliykat

@eliykat it might be better to hold off for a little bit. I'm almost ready to convert the contributing-docs repo into a public one (🥳 ). I just need to finish up some work to get bitwarden-employee-specific information a little more clearly indicated.

That being said, @junyuan-z, I should be able to attribute you as a co-author at least once I port over these changes to the public repo. Up to you on the route you'd rather go -- direct PR merge or just getting the info out there sooner.

MGibson1 avatar Nov 09 '22 22:11 MGibson1

I think @fedemkr was going to look into it, as he knows more about mobile development to assess these instructions/workarounds. But I agree getting this submitted against the docs repo once it's public would be ideal.

eliykat avatar Nov 10 '22 21:11 eliykat

so should I make the change & try to land it into this repo?

junyuanz1 avatar Mar 17 '23 01:03 junyuanz1

We now have a public documentation repo you can submit it to: https://github.com/bitwarden/contributing-docs

Specifically I think it would live somewhere in here: https://github.com/bitwarden/contributing-docs/tree/master/docs/getting-started/clients/mobile/ios

If you open a new PR there and close this one, I can chase up the mobile team for a review. Thanks!

eliykat avatar Mar 20 '23 06:03 eliykat