diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..b61d5c9 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,40 @@ +name: docs +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + permissions: + contents: write # To push a branch + pages: write # To push to a GitHub Pages site + id-token: write # To update the deployment status + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Install latest mdbook + run: | + tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name') + url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz" + mkdir mdbook + curl -sSL $url | tar -xz --directory=./mdbook + echo `pwd`/mdbook >> $GITHUB_PATH + - name: Build Book + run: | + # This assumes your book is in the root of your repository. + # Just add a `cd` here if you need to change to another directory. + cd docs + mdbook build + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: 'docs/book' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..7214617 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,28 @@ +# Summary + +[Introduction](introduction.md) + +# Tutorials + +- [Getting started on GitHub](tutorials/github.md) +- [Getting started on GitLab]() + +# Explanation + +- [Release Pull Request](explanation/release-pr.md) + +# Guides + +- [Customizing Release Notes](guides/release-notes.md) +- [Pre-releases](guides/pre-releases.md) +- [Workflow Permissions on GitHub](guides/github-workflow-permissions.md) + +# Reference + +- [Pull Request Options](reference/pr-options.md) +- [GitHub Action](reference/github-action.md) +- [GitLab CI]() + +--- + +[Changelog](changelog.md) diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..c109a67 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,8 @@ +[book] +language = "en" +multilingual = false +src = "." +title = "releaser-pleaser" + +[build] +build-dir = "book" diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..ff8ce10 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,3 @@ +# Changelog + +{{#include ../CHANGELOG.md:2: }} diff --git a/docs/explanation/release-pr.md b/docs/explanation/release-pr.md new file mode 100644 index 0000000..f043db4 --- /dev/null +++ b/docs/explanation/release-pr.md @@ -0,0 +1 @@ +# Release Pull Request diff --git a/docs/guides/github-workflow-permissions.md b/docs/guides/github-workflow-permissions.md new file mode 100644 index 0000000..45b87fb --- /dev/null +++ b/docs/guides/github-workflow-permissions.md @@ -0,0 +1 @@ +# Workflow Permissions on GitHub diff --git a/docs/guides/pre-releases.md b/docs/guides/pre-releases.md new file mode 100644 index 0000000..fd2bbf8 --- /dev/null +++ b/docs/guides/pre-releases.md @@ -0,0 +1 @@ +# Pre-releases diff --git a/docs/guides/release-notes.md b/docs/guides/release-notes.md new file mode 100644 index 0000000..ed1d1e2 --- /dev/null +++ b/docs/guides/release-notes.md @@ -0,0 +1 @@ +# Customizing Release Notes diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..04ec94d --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,3 @@ +# Introduction + +{{#include ../README.md:2:}} diff --git a/docs/reference/github-action.md b/docs/reference/github-action.md new file mode 100644 index 0000000..2bc8ce9 --- /dev/null +++ b/docs/reference/github-action.md @@ -0,0 +1 @@ +# GitHub Action diff --git a/docs/reference/pr-options.md b/docs/reference/pr-options.md new file mode 100644 index 0000000..6b6ba14 --- /dev/null +++ b/docs/reference/pr-options.md @@ -0,0 +1 @@ +# Pull Request Options diff --git a/docs/tutorials/github.md b/docs/tutorials/github.md new file mode 100644 index 0000000..c27f953 --- /dev/null +++ b/docs/tutorials/github.md @@ -0,0 +1 @@ +# GitHub