diff --git a/.github/workflows/build-pdf.yml b/.github/workflows/build-pdf.yml index b7be4dd..6eecf0d 100644 --- a/.github/workflows/build-pdf.yml +++ b/.github/workflows/build-pdf.yml @@ -8,7 +8,7 @@ on: description: 'Release version, e.g. X.Y.Z:' required: true type: string - revision_mark: + revision_mark: description: 'Set revision mark as Draft, Release or Stable:' required: true type: string @@ -57,7 +57,7 @@ jobs: name: Build Artifacts path: ${{ github.workspace }}/*.pdf retention-days: 30 - + # Create Release - name: Create Release uses: softprops/action-gh-release@v1 @@ -69,5 +69,5 @@ jobs: prerelease: ${{ github.event.inputs.prerelease }} env: GITHUB_TOKEN: ${{ secrets.GHTOKEN }} - if: github.event_name == 'workflow_dispatch' + if: github.event_name == 'workflow_dispatch' # This condition ensures this step only runs for workflow_dispatch events. diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml new file mode 100644 index 0000000..c2f7e71 --- /dev/null +++ b/.github/workflows/pre-commit.yml @@ -0,0 +1,14 @@ +name: pre-commit + +on: + pull_request: + push: + branches: [main] + +jobs: + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + - uses: pre-commit/action@v3.0.0 diff --git a/.gitignore b/.gitignore index bd98a73..a136337 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ *.pdf - diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..d174cf9 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,10 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-json + - id: check-symlinks + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c79557..1d98c72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,4 +55,4 @@ You can manually add the DCO text to your commit body or include either -s or -- Note: -Ensure that the name and email address associated with your GitHub account match the name and email address in the Signed-off-by line of your commit message. \ No newline at end of file +Ensure that the name and email address associated with your GitHub account match the name and email address in the Signed-off-by line of your commit message. diff --git a/LICENSE b/LICENSE index 53883b1..2f244ac 100644 --- a/LICENSE +++ b/LICENSE @@ -49,7 +49,7 @@ exhaustive, and do not form part of our licenses. such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More_considerations - for the public: + for the public: wiki.creativecommons.org/Considerations_for_licensees ======================================================================= @@ -393,4 +393,3 @@ the avoidance of doubt, this paragraph does not form part of the public licenses. Creative Commons may be contacted at creativecommons.org. - diff --git a/Makefile b/Makefile index a46d659..5b0b05a 100644 --- a/Makefile +++ b/Makefile @@ -8,8 +8,8 @@ # SPDX-License-Identifier: CC-BY-SA-4.0 # # Description: -# -# This Makefile is designed to automate the process of building and packaging +# +# This Makefile is designed to automate the process of building and packaging # the Doc Template for RISC-V Extensions. DATE ?= $(shell date +%Y-%m-%d) @@ -39,7 +39,7 @@ REQUIRES := --require=asciidoctor-bibtex \ all: build -build: +build: @echo "Checking if Docker is available..." @if command -v docker >/dev/null 2>&1 ; then \ echo "Docker is available, building inside Docker container..."; \ diff --git a/example.bib b/example.bib index 9da24b1..4c368b1 100644 --- a/example.bib +++ b/example.bib @@ -33,4 +33,4 @@ @article{spur-jsscc1989 number = {6}, pages = {1688-1698}, month = {December} -} \ No newline at end of file +}