Upload cookbook docs to artifacts #1981
Conversation
|
|
||
| - name: Compress | ||
| run: | | ||
| tar czvf ${{ env.NAME }}.tar.gz cookbook FULL_HELP_DOCS.md |
There was a problem hiding this comment.
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.
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.
I think they should be separate. And named by what they contain. The user manual is at least maybe interesting to others.
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