-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Asciidoc template and GH CI automation
Signed-off-by: Rafael Sene <[email protected]>
- Loading branch information
Showing
3 changed files
with
107 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
name: Build Charter | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
types: [opened, reopened, edited] | ||
branches: | ||
- main | ||
workflow_dispatch: | ||
inputs: | ||
prerelease: | ||
description: 'Tag as a pre-release?' | ||
required: false | ||
type: boolean | ||
default: true | ||
draft: | ||
description: 'Create release as a draft?' | ||
required: false | ||
type: boolean | ||
default: false | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Build Container Image | ||
run: docker build -t riscv-charter ./ | ||
|
||
- name: Build Newsletter | ||
run: docker run --rm -v ${PWD}:/build -w /build riscv-charter:latest | ||
|
||
- name: Upload PDF | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: Charter PDF | ||
path: ${{ github.workspace }}/*.pdf | ||
|
||
# Create Release | ||
- name: Create Release | ||
uses: softprops/action-gh-release@v1 | ||
with: | ||
files: ${{ github.workspace }}/*.pdf | ||
tag_name: charter-${{ github.run_number }} | ||
name: Charter ${{ github.run_number }} | ||
draft: ${{ github.event.inputs.draft }} | ||
prerelease: ${{ github.event.inputs.prerelease }} | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GHTOKEN }} | ||
if: github.event_name == 'workflow_dispatch' | ||
# This condition ensures this step only runs for workflow_dispatch events. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Use the riscvintl/riscv-docs-base-container-image as a base image | ||
FROM riscvintl/riscv-docs-base-container-image:latest | ||
|
||
# Metadata as a label | ||
LABEL maintainer="Rafael Sene [email protected]" | ||
|
||
# Set the working directory in the container to /build | ||
WORKDIR /build | ||
|
||
# Run asciidoctor-pdf when the container launches | ||
CMD sh -c "asciidoctor-pdf -o charter-$(date +%Y%m%d).pdf \ | ||
-a compress ./charter.adoc" |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
= { New Group Name } { New Group Type } Charter | ||
|
||
== Introduction | ||
|
||
The {New Group Name} {New Group Type} aims to [INSERT CLEAR, CONCISE OVERALL MISSION STATEMENT IN 2-3 SENTENCES]. | ||
|
||
== Definitions (Optional) | ||
|
||
[TERM 1] refers to [DEFINITION 1]. It is critical because [EXPLAIN SIGNIFICANCE]. [INCLUDE ADDITIONAL TERMS/DEFINITIONS IF REQUIRED]. | ||
|
||
== Background | ||
|
||
[PROVIDE CONTEXT ABOUT THE GROUP'S RELEVANCE AND ANY PERTINENT TECHNOLOGY]. | ||
|
||
== Objectives | ||
|
||
The {New Group Name} {New Group Type} is committed to delivering [SPECIFY DELIVERABLE] with the following attributes: | ||
|
||
* [ATTRIBUTE 1] | ||
* [ATTRIBUTE 2] | ||
* [ADD MORE AS REQUIRED] | ||
|
||
== Exclusions (Optional) | ||
|
||
While not currently in scope, the following items may be considered for future iterations: | ||
|
||
* [FEATURE 1] | ||
* [FEATURE 2] | ||
* [ADD MORE AS REQUIRED] | ||
|
||
== Collaborations | ||
|
||
To fulfill its objectives, the {New Group Name} {New Group Type} will engage with: | ||
|
||
* [GROUP NAME 1] [GROUP TYPE 1] | ||
* [GROUP NAME 2] [GROUP TYPE 2] | ||
* [ADDITIONAL GROUPS AS NEEDED] | ||
|
||
NOTE: Ensure to replace all placeholders ({ }) with the actual names or information and remove any optional sections that are not applicable to your charter. Also, remove this note :) |