Deploy develop docs in CI, updated readme

This commit is contained in:
Jamie Curnow 2024-01-09 08:36:32 +10:00
parent 09d5e2c94f
commit e4ef095254
No known key found for this signature in database
GPG Key ID: FFBB624C43388E9E
2 changed files with 38 additions and 13 deletions

35
Jenkinsfile vendored
View File

@ -22,8 +22,6 @@ pipeline {
COMPOSE_FILE = 'docker/docker-compose.ci.yml' COMPOSE_FILE = 'docker/docker-compose.ci.yml'
COMPOSE_INTERACTIVE_NO_CLI = 1 COMPOSE_INTERACTIVE_NO_CLI = 1
BUILDX_NAME = "${COMPOSE_PROJECT_NAME}" BUILDX_NAME = "${COMPOSE_PROJECT_NAME}"
DOCS_BUCKET = 'jc21-npm-site'
DOCS_CDN = 'EN1G6DEWZUTDT'
} }
stages { stages {
stage('Environment') { stage('Environment') {
@ -175,16 +173,33 @@ pipeline {
} }
} }
stage('Docs Deploy') { stage('Docs Deploy') {
when { parallel {
allOf { stage('Master') {
branch 'master' when {
not { allOf {
equals expected: 'UNSTABLE', actual: currentBuild.result branch 'master'
not {
equals expected: 'UNSTABLE', actual: currentBuild.result
}
}
}
steps {
npmDocsReleaseMaster()
}
}
stage('Develop') {
when {
allOf {
branch 'develop'
not {
equals expected: 'UNSTABLE', actual: currentBuild.result
}
}
}
steps {
npmDocsReleaseDevelop()
} }
} }
}
steps {
npmDocsRelease("$DOCS_BUCKET", "$DOCS_CDN")
} }
} }
stage('PR Comment') { stage('PR Comment') {

View File

@ -98,7 +98,18 @@ Password: changeme
Immediately after logging in with this default user you will be asked to modify your details and change your password. Immediately after logging in with this default user you will be asked to modify your details and change your password.
## Contributors ## Contributing
All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch.
CI is used in this project. All PR's must pass before being considered. After passing,
docker builds for PR's are available on dockerhub for manual verifications.
Documentation within the `develop` branch is available for preview at
[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com)
### Contributors
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors). Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
@ -107,5 +118,4 @@ Special thanks to [all of our contributors](https://github.com/NginxProxyManager
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues) 1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions) 2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community) 3. [Reddit](https://reddit.com/r/nginxproxymanager)
4. [Reddit](https://reddit.com/r/nginxproxymanager)