Skip to content

Commit

Permalink
Merge pull request #159 from nginx/azure-action
Browse files Browse the repository at this point in the history
Add GitHub Action for site and preview deployments
  • Loading branch information
avahahn authored Aug 13, 2024
2 parents 9c820c3 + 35e585a commit 2c6fb03
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 22 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs-build-push.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Build and deploy docs (unit.nginx.org)
on:
workflow_dispatch:
inputs:
environment:
description: 'Environment to deploy to'
required: true
default: 'preview'
type: choice
options:
- preview
- dev
- staging
- prod
pull_request:
branches:
- "*"

permissions:
contents: read

jobs:
call-docs-build-push:
uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@main
permissions:
pull-requests: write # needed to write preview url comment to PR
contents: read
with:
production_url_path: ""
preview_url_path: "/previews/unit"
docs_source_path: "deploy"
docs_build_path: "."
doc_type: "sphinx"
environment: ${{inputs.environment}}
secrets:
AZURE_CREDENTIALS: ${{secrets.AZURE_CREDENTIALS_DOCS}}
AZURE_KEY_VAULT: ${{secrets.AZURE_KEY_VAULT_DOCS}}
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ pip install -r requirements.txt
make serve
```

Commits in any branch associated with a Pull Request, if made by a maintainer, will automatically deploy a preview site. A comment with a link to the preview will show up in the PR.

## Deployment

See the [`docs-actions` README](https://github.com/nginxinc/docs-actions/tree/main?tab=readme-ov-file#docs-actions).

## Contributing

Pull requests are welcome. For major changes, please open an issue
Expand Down
22 changes: 0 additions & 22 deletions netlify.toml

This file was deleted.

0 comments on commit 2c6fb03

Please sign in to comment.