Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: implement packages structure and publication #32

Closed
wants to merge 9 commits into from
Closed

feat: implement packages structure and publication #32

wants to merge 9 commits into from

Conversation

aeddi
Copy link
Member

@aeddi aeddi commented Mar 9, 2020

Description

The purpose of this PR is to make gomobile-ipfs available on Android/iOS package managers (Cocoapods and Gradle/Maven).

  • Added a Manifest.yml file to centralize the configuration of the different packages
  • Changed the Makefile rules and added utilities for formatting and publishing packages on Cocoapods/Maven
  • Added javadoc in the Android bridge and markdown doc in the iOS bridge in order to:
    • Comply with maven's requirements
    • Provide documentation directly in the IDEs while using Bridge packages
    • Potentially, generate the documentation to put it online
  • Added CI rules to lint, test and release packages:
    • Docs for Android and iOS is generated by CI and published on github-pages
    • A global changelog is generated by semantic-release/changelog
    • Version number and Github release are generated by semantic-release
  • Cleaned up and reorganized folders

After discussion with my team, we chose to have a single version number for all packages (android/ios bridge/core/demo).
The version numbers of some packages will sometimes be bumped without changes, but it will be much easier to automate via the CI (tag, release, publish, etc...) and to use on the user side.

This PR requires to add secrets (Bintray, Cocoapods) in the repo settings to work.

As a second step, it would be nice to set up a Bintray repo in the name of IPFS, but I let the Protocol Labs teams take care of it so that they keep all sensitive information secret.

Related

@aeddi aeddi requested a review from gfanton March 9, 2020 08:43
@aeddi aeddi self-assigned this Mar 9, 2020
packages/Manifest.yml Outdated Show resolved Hide resolved
Copy link
Member

@gfanton gfanton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

ios/Bridge/GomobileIPFS/Sources/Node.swift Outdated Show resolved Hide resolved
@aeddi aeddi changed the title feat: implement package structure and publication feat: implement packages structure and publication Mar 13, 2020
@aeddi aeddi closed this Mar 13, 2020
@aeddi aeddi reopened this Mar 13, 2020
@aeddi aeddi closed this Mar 13, 2020
@aeddi aeddi deleted the dev/packages-structure branch March 17, 2020 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants