generated from riscv/docs-spec-template
-
Notifications
You must be signed in to change notification settings - Fork 34
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
Merge from templates repo #79
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Stephano Cetola <[email protected]>
Simple example bibliography and index. Signed-off-by: Stephano Cetola <[email protected]>
Ignore all PDF output that is generated. Use GitHub actions and releases for publishing PDFs. Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Push to the latest commit for docs-resources and pull in the new SVG logo Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Stephano Cetola <[email protected]>
$default-branch can be used in Workflow templates, but not in Workflows.
Signed-off-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Signed-of-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
This adds the option to do a prerelease of the pdf build when that worflow_dispatch is manually run. The name of the release is based of the branch or tag name, so ideally one would run this with a branch name of the style: v0.1.0.
As part of this template we require each specification to provide at minimum the license(s) that the repository requires and the statement regarding the DCO. Authors are encouraged to update this file with any additional comments relevant to their specification. Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Stephano Cetola <[email protected]>
Signed-off-by: Bin Meng <[email protected]>
LICENSE, contributors.adoc and CONTRIBUTING.md are all local to this repo, so let's link to their relative path in the readme.adoc file. While we are here, omit the .adoc suffix in the the contributors.adoc link display name. Signed-off-by: Bin Meng <[email protected]>
Will add in as a separate workflow. Signed-off-by: Jeff Scheel <[email protected]>
- Establish env var for target NAME - Add outputs.name and outputs.pdf-name for consumption by other workflows Signed-off-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Signed-off-by: Jeff Scheel <[email protected]>
Making the code blocks copyable. Signed-off-by: Bill Traynor <[email protected]>
* add basic source checks for existing file types * commit fixes from auto-corrections (eoln and eof fixes) * add github action to run pre-commit hooks in CI Signed-off-by: Kevin Broch <[email protected]>
initial add of pre-commit tool for linting source
Signed-off-by: Kevin Broch <[email protected]>
…other-asciidoc-file-extensions disallow other file extensions for asciidoc other than .adoc
also autofix of existing files fixes riscv#22 Signed-off-by: Kevin Broch <[email protected]>
…re-commit add yamlfmt pre-commit hook
fixes riscv#18 Signed-off-by: Kevin Broch <[email protected]>
add html output
relates to riscv#25 Signed-off-by: Kevin Broch <[email protected]>
move asciidoc source files to src; build docs in build dir
related to riscv#26 other minor edits: * minor wording changes * add line spacing between blocks * add `shell` to code blocks Signed-off-by: Kevin Broch <[email protected]>
relates to riscv#25 Signed-off-by: Kevin Broch <[email protected]>
Signed-off-by: Kevin Broch <[email protected]>
…uild dir instead of outfile Signed-off-by: Kevin Broch <[email protected]>
Signed-off-by: Rafael Sene <[email protected]>
Signed-off-by: Alex Richardson <[email protected]>
Add instructions on how to enable pre-commit
andresag01
approved these changes
Jan 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since the initial commit was squashed, this uses --allow-unrelated-histories to bring back the templates history.
See #77