-
Notifications
You must be signed in to change notification settings - Fork 88
Upload cookbook docs to artifacts #1981
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea!
.github/workflows/binaries.yml
Outdated
|
||
- name: Compress | ||
run: | | ||
tar czvf ${{ env.NAME }}.tar.gz cookbook FULL_HELP_DOCS.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cookbook and full help are different things. The full help docs is referred to as the user manual in the docs, so I think we should rename the job to User Manual. We could rename the .md file to USER_MANUAL too maybe for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think we should upload FULL_HELP_DOCS.md and cookbook.tar.gz as separate artifacts?
Because the artifacts are not intended to be used by the end user, just by our docs, so I think it makes sense to keep it in 1 tar, and keep the naming the same to avoid confusion by developers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think they should be separate. And named by what they contain. The user manual is at least maybe interesting to others.
The PR description says the aim is to decouple cookbook docs from the CLI release, however this PR seems to explicitly make the cookbooks a release artifact, therefore further coupling the cookbooks to the release. 🤔 Is the goal to be able to regenerate and rewrite the release cookbook artifact in cases when the cookbook has an error? 🫨 Setting up a process to rewrite release artifact's is somewhat terrifying, as the release artifacts should be built one time, from the release itself and never tampered with. The underlying issue seems to me to be that the cookbooks in this repo are not being tested, and if they're to live in this repo instead of the stellar-docs repo, they should probably be tested here. Have we explored that option? |
Yes, the idea is to combine this approaches (see #1908) |
We decided not to to with this approach |
What
Uploads cookbook docs to artifacts
Why
To decouple cookbook docs from our actual release and avoid potential breakage
docs PR: stellar/stellar-docs#1439
Known limitations
I manually uploaded artifact produced by the latest run to 22.6.0 release