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

Ab#57356 doctool #85

Merged
merged 4 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 9 additions & 32 deletions .github/workflows/generate-readme.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,19 @@ on:
required: true

jobs:
generate-readme:
update-docs:
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
action: [generate-screenshots, generate-repository-docs, lint-manifest]
steps:
- uses: actions/checkout@v4
name: Checkout project
- name: Checkout
uses: actions/checkout@v4
with:
token: ${{ secrets.token }}

- uses: actions/checkout@v4
name: Checkout templates
- uses: Keyfactor/doctool@main
with:
repository: 'Keyfactor/actions'
path: './actions/'
token: ${{ secrets.token }}
ref: 'v2' # Update this tag for testing new readme templates branches
- uses: Keyfactor/jinja2-action@v1.2.0-multiple-data-files
name: Merge template and manifest with jinja2
with:
template: ./actions/readme-templates/readme.md.tpl
output_file: README.md
data_file: |
integration-manifest.json
./actions/readme-templates/readme_shared_data.json
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Show generated README.md
run: echo $(cat README.md)

- uses: Keyfactor/add-and-commit@v9.1.4
name: Commit generated README
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
add: README.md --force
message: Update generated README
author_name: Keyfactor
author_email: keyfactor@keyfactor.github.io
action: ${{ matrix.action }}
2 changes: 1 addition & 1 deletion .github/workflows/starter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ jobs:

call-generate-readme-workflow:
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
uses: Keyfactor/actions/.github/workflows/generate-readme.yml@v3
uses: Keyfactor/actions/.github/workflows/generate-readme.yml@ab#57356-doctool
secrets:
token: ${{ secrets.APPROVE_README_PUSH }}

Expand Down