{"id":15023101,"url":"https://github.com/ntno/deploy-mkdocs-composite-action","last_synced_at":"2026-02-15T00:14:24.168Z","repository":{"id":65068024,"uuid":"581620491","full_name":"ntno/deploy-mkdocs-composite-action","owner":"ntno","description":"reusable GitHub Action to deploy MkDocs site ","archived":false,"fork":false,"pushed_at":"2025-09-08T14:29:24.000Z","size":12,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-30T10:15:55.874Z","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-23T18:34:00.000Z","updated_at":"2025-03-16T23:54:45.000Z","dependencies_parsed_at":"2025-04-04T09:41:52.746Z","dependency_job_id":"20e3ea35-2671-4599-adfd-8e0d82726dd5","html_url":"https://github.com/ntno/deploy-mkdocs-composite-action","commit_stats":{"total_commits":4,"total_committers":1,"mean_commits":4.0,"dds":0.0,"last_synced_commit":"7a6a09e6af577414b05df18c256fe33e8a09b066"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ntno/deploy-mkdocs-composite-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fdeploy-mkdocs-composite-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fdeploy-mkdocs-composite-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fdeploy-mkdocs-composite-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fdeploy-mkdocs-composite-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ntno","download_url":"https://codeload.github.com/ntno/deploy-mkdocs-composite-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntno%2Fdeploy-mkdocs-composite-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279008636,"owners_count":26084480,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-09-24T19:58:44.231Z","updated_at":"2025-10-11T20:48:43.063Z","avatar_url":"https://github.com/ntno.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# deploy-mkdocs-composite-action\nreusable github action to deploy mkdocs site to S3\n\n## features\n- configures AWS credentials\n- gets mkdocs site archive\n- deploys mkdocs site\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\n\njobs:\n  deploy-pr:\n    runs-on: ubuntu-latest\n    environment: ci\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3   \n      - name: Deploy PR\n        id: deploy-mkdocs\n        uses: ntno/deploy-mkdocs-composite-action@v4\n        with:         \n          version: 1.0.3-pr\n          env-name: prod\n          s3-bucket: my-s3-bucket-1.0.3-pr\n          aws-region: us-east-2\n          role-to-assume: arn:aws:iam::************:role/CI-ntno.net\n```\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  deploy-pr:\n    runs-on: ubuntu-latest\n    environment: ci\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3   \n      - name: Deploy PR\n        id: deploy-mkdocs\n        uses: ntno/deploy-mkdocs-composite-action@v4\n        with:         \n          version: 1.0.3-pr\n          env-name: prod\n          s3-bucket: my-s3-bucket-1.0.3-pr\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  version:\n    description: 'Build version to deploy.  Used to get archive at unique S3 key.  Ex: sha-####, 3.0.0'\n    required: true\n    type: string\n  env-name:\n    description: 'Environment name.  Ex: dev, prod'\n    default: 'dev'\n    required: true\n    type: string\n  s3-bucket:\n    description: 'S3 Bucket to deploy to.'\n    required: true\n    type: string\n  make-vars:\n    description: 'Variables to pass to all make commands.  Ex: `--no-print-directory` would result in `make --no-print-directory get-mkdocs-archive...`'\n    default: \"--no-print-directory\"\n    required: false\n    type: string\n  make-vars-for-deploy-target:\n    description: 'Variables to pass to `deploy-mkdocs` make command.  Ex: `QUIET=1` would result in `make QUIET=1 deploy-mkdocs...`'\n    default: \"\"\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```\n\n## prerequisites\nexpects Makefile in mkdocs project with the following directives:\n```\nget-mkdocs-archive: env region version download-directory\ndeploy-mkdocs: env region bucket-name\n```\n### get-mkdocs-archive\nuse this directive to retrieve and unpack mkdocs artifact (ex: download archive from S3 and unzip)\n\n### deploy-mkdocs\nuse this directive to deploy mkdocs site to S3 bucket\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntno%2Fdeploy-mkdocs-composite-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntno%2Fdeploy-mkdocs-composite-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntno%2Fdeploy-mkdocs-composite-action/lists"}