{"id":15447312,"url":"https://github.com/ntno/build-mkdocs-composite-action","last_synced_at":"2026-03-01T18:02:35.914Z","repository":{"id":65065948,"uuid":"581600741","full_name":"ntno/build-mkdocs-composite-action","owner":"ntno","description":"reusable GitHub Action to build and archive MkDocs site ","archived":false,"fork":false,"pushed_at":"2026-02-09T17:52:45.000Z","size":28,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-10T23:57:58.787Z","etag":null,"topics":["github-actions","github-composite-action","mkdocs"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ntno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-12-23T17:18:19.000Z","updated_at":"2025-03-16T23:57:18.000Z","dependencies_parsed_at":"2024-11-16T15:04:57.321Z","dependency_job_id":"687fffa7-1ecf-4b68-b2fd-c87f2701d5a5","html_url":"https://github.com/ntno/build-mkdocs-composite-action","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"ffe2d92711bd02d6aed9e3c105ff1435e740465e"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/ntno/build-mkdocs-composite-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fbuild-mkdocs-composite-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fbuild-mkdocs-composite-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fbuild-mkdocs-composite-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fbuild-mkdocs-composite-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ntno","download_url":"https://codeload.github.com/ntno/build-mkdocs-composite-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fbuild-mkdocs-composite-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29977966,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T16:35:47.903Z","status":"ssl_error","status_checked_at":"2026-03-01T16:35:44.899Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","github-composite-action","mkdocs"],"created_at":"2024-10-01T20:04:50.116Z","updated_at":"2026-03-01T18:02:35.901Z","avatar_url":"https://github.com/ntno.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# build-mkdocs-composite-action\n## features\n- configures AWS credentials\n- sets up python and loads pip cache\n- builds mkdocs site\n- archives mkdocs site to AWS (optional)\n\n## usage\n\n### [Recommended - Assume Role directly using GitHub OIDC provider](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role)\n*__note:__* using OIDC requires `id-token` write and `contents` read  permissions granted to GITHUB_TOKEN. see [Assigning permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) for more information on assigning workflow permissions.\n```\npermissions:\n  id-token: write\n  contents: read\njobs:\n  build-pr:\n    runs-on: ubuntu-latest\n    steps: \n      - name: Checkout\n        uses: actions/checkout@v3\n      - name: Build PR\n        uses: ntno/build-mkdocs-composite-action@v6\n        with:\n          archive-enabled: true\n          version: 1.0.3-pr\n          env-name: prod\n          aws-region: us-east-2\n          role-to-assume: arn:aws:iam::************:role/CI-ntno.net\n```\n\n### [IAM User](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role)\n*__note:__* Secrets for composite actions must be configured using an [`environment`](https://docs.github.com/en/actions/using-jobs/using-environments-for-jobs).  The `ci` environment is used in the following example.  It contains the secrets `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.\n\n```\njobs:\n  build-pr:\n    runs-on: ubuntu-latest\n    environment: ci\n    steps: \n      - name: Checkout\n        uses: actions/checkout@v3\n      - name: Build PR\n        uses: ntno/build-mkdocs-composite-action@v6\n        with:\n          archive-enabled: true\n          version: 1.0.3-pr\n          env-name: prod\n          aws-region: us-east-2\n          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}\n          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}\n```\n\n## inputs\n```\n  archive-enabled:\n    description: 'Enables archiving of build artifact.  Ex: `true` or `false`'\n    default: false\n    required: true\n    type: boolean\n  version:\n    description: 'Build version.  Used to store archive at unique S3 key.  Ex: sha-####, 3.0.0'\n    required: false\n    type: string\n  env-name:\n    description: 'Environment name.  Ex: dev, prod'\n    default: 'dev'\n    required: true\n    type: string\n  make-vars:\n    description: 'Variables to pass to all make commands.  Ex: `QUIET=1` would result in `make QUIET=1 build-mkdocs...`'\n    default: \"--no-print-directory\"\n    required: false\n    type: string\n  aws-region:\n    description: 'AWS Region.  Ex: us-east-1'\n    default: 'us-east-1'\n    required: true\n    type: string                      \n  aws-access-key-id:\n    description: 'AWS Access Key ID.'\n    required: false\n  aws-secret-access-key:\n    description: 'AWS Secret Access Key.'\n    required: false\n  role-to-assume:\n    description: \u003e-\n      Use the provided credentials to assume an IAM role and configure the Actions\n      environment with the assumed role credentials rather than with the provided\n      credentials\n    required: false\n  role-duration-seconds:\n    description: \"Role duration in seconds (default: 6 hours, 1 hour for OIDC/specified aws-session-token)\"\n    required: false\n  role-session-name:\n    description: 'Role session name (default: GitHubActions)'\n    required: false\n  role-external-id:\n    description: 'The external ID of the role to assume'\n    required: false\n  role-skip-session-tagging:\n    description: 'Skip session tagging during role assumption'\n    required: false    \n  python-version:\n    description: 'Python Version'\n    default: '3.8'\n    required: true\n    type: string\n```\n\n## prerequisites\nexpects Makefile in mkdocs project with the following directives:\n```\nsetup-mkdocs: env region download-directory\nbuild-mkdocs: env region\narchive-mkdocs: env region version\n```\n### setup-mkdocs\nuse this directive to handle any steps prior to building (ex: download external image assets)\n\n### build-mkdocs\nuse this directive to build mkdocs site\n\n### archive-mkdocs (optional)\nuse this directive to upload the site to S3\n\n## see also  \n- [Use OpenID Connect within your workflows to authenticate with Amazon Web Services.](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services) \n- [AWS Credentials GitHub action](https://github.com/aws-actions/configure-aws-credentials)\n\n## references\n- https://docs.github.com/en/actions/creating-actions/creating-a-composite-action\n- https://docs.github.com/en/actions/using-jobs/using-environments-for-jobs","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntno%2Fbuild-mkdocs-composite-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntno%2Fbuild-mkdocs-composite-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntno%2Fbuild-mkdocs-composite-action/lists"}