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

Add CI/CD from docs-templates repo #118

Merged
merged 2 commits into from
Dec 18, 2024

Conversation

cmuellner
Copy link
Collaborator

This adds the CI/CD scripts from the docs-templates repo.

Signed-off-by: Christoph Müllner <christoph.muellner@vrull.eu>
@cmuellner
Copy link
Collaborator Author

@apazos, @kito-cheng, or @wmat, please review.

Signed-off-by: Christoph Müllner <christoph.muellner@vrull.eu>
@apazos
Copy link
Collaborator

apazos commented Dec 12, 2024

That is what I was planning to do, to use the workflow from the docs template.
I actually pushed a draft PR and tested it in my branch: https://github.com/apazos/riscv-c-api-doc/actions/runs/12242758695
It worked fine.
But I included both *.pdf and *.html files in the artifacts. You might want to add them both.
This means in the "Upload Build Artifacts" action, add both files:

 path: |
    ${{ github.workspace }}/build/*.pdf
    ${{ github.workspace }}/build/*.html

@cmuellner
Copy link
Collaborator Author

@apazos, my PRs were not meant to overtake the plans of others.

Given we had different levels of CI/CD support in the three repos (TC, CAPI, ASM), I just wanted to establish a common baseline. The background is, that we got PRs for some repos that add a dependabot action, and I want to avoid the repos diverging even more.

Feel free to provide PRs that enhance the CI/CD pipelines as you've planned.

@cmuellner
Copy link
Collaborator Author

@wmat, ping. Please approve this PR. It would be great to merge this as well.

Copy link
Contributor

@wmat wmat left a comment

Choose a reason for hiding this comment

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

LGTM thanks.

@cmuellner cmuellner merged commit 49dd41d into riscv-non-isa:main Dec 18, 2024
2 checks passed
@apazos
Copy link
Collaborator

apazos commented Dec 18, 2024

Hi @cmuellner, no worries. Looking at https://github.com/riscv-non-isa/riscv-asm-manual/releases, it seems it already included all the files from the build directory, both html and pdf files. I thought we would have to fix some rule to make sure they appear under Assets.

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

Successfully merging this pull request may close these issues.

3 participants