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

Generate and publish API docs on CI #16

Open
MaxDesiatov opened this issue Dec 14, 2018 · 1 comment
Open

Generate and publish API docs on CI #16

MaxDesiatov opened this issue Dec 14, 2018 · 1 comment
Assignees

Comments

@MaxDesiatov
Copy link
Collaborator

XMLCoder should have publicly visible docs for its API. First option to consider for auto-generated docs is Jazzy. Generated docs could be published with GitHub Pages.

@MaxDesiatov
Copy link
Collaborator Author

MaxDesiatov commented Dec 18, 2018

It looks like Jazzy doesn't support generation of docs for multiple versions of the library. This means we'd need to upload docs to a correct url within the xmlcoder.org S3 bucket. I propose checking TRAVIS_BRANCH and TRAVIS_TAG environment variables in .travis.yml during a CI build. When TRAVIS_BRANCH is master, jazzy output should be uploaded to xmlcoder.org/docs/master path. For any other branch jazzy should still run to make sure that docs generation is not broken, but I don't think it's worth uploading docs for every PR and branch. Also, if TRAVIS_TAG has a value, an upload to xmlcoder.org/docs/$TRAVIS_TAG should occur.

After this works we could keep a predefined or somehow generated automatically file at xmlcoder.org/index.html to either redirect to the latest stable docs version or show a landing page with a correct link to the docs.

@MaxDesiatov MaxDesiatov reopened this Dec 18, 2018
@MaxDesiatov MaxDesiatov assigned MaxDesiatov and unassigned hodovani Jan 18, 2019
@MaxDesiatov MaxDesiatov changed the title Generate and publish Jazzy docs Generate and publish API docs on CI Jan 22, 2019
bwetherfield added a commit to bwetherfield/XMLCoder that referenced this issue Jul 16, 2019
bwetherfield added a commit to bwetherfield/XMLCoder that referenced this issue Jul 26, 2019
bwetherfield pushed a commit to bwetherfield/XMLCoder that referenced this issue Jul 26, 2019
Add benchmark baselines

Pull in tests (CoreOffice#11)

Add Decoding support for choice elements (CoreOffice#15)

Fix indentation (CoreOffice#16)

Replace usage of XCTUnrwap (CoreOffice#19)

Add nested choice tests (CoreOffice#18)

Add falsely passing double array roundtrip test (CoreOffice#17)
bwetherfield pushed a commit to bwetherfield/XMLCoder that referenced this issue Jul 27, 2019
Add benchmark baselines

Pull in tests (CoreOffice#11)

Add Decoding support for choice elements (CoreOffice#15)

Fix indentation (CoreOffice#16)

Replace usage of XCTUnrwap (CoreOffice#19)

Add nested choice tests (CoreOffice#18)

Add falsely passing double array roundtrip test (CoreOffice#17)
bwetherfield added a commit to bwetherfield/XMLCoder that referenced this issue Jul 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants