Skip to content

Commit e4ef095

Browse files
committed
Deploy develop docs in CI, updated readme
1 parent 09d5e2c commit e4ef095

File tree

2 files changed

+38
-13
lines changed

2 files changed

+38
-13
lines changed

Diff for: Jenkinsfile

+25-10
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ pipeline {
2222
COMPOSE_FILE = 'docker/docker-compose.ci.yml'
2323
COMPOSE_INTERACTIVE_NO_CLI = 1
2424
BUILDX_NAME = "${COMPOSE_PROJECT_NAME}"
25-
DOCS_BUCKET = 'jc21-npm-site'
26-
DOCS_CDN = 'EN1G6DEWZUTDT'
2725
}
2826
stages {
2927
stage('Environment') {
@@ -175,16 +173,33 @@ pipeline {
175173
}
176174
}
177175
stage('Docs Deploy') {
178-
when {
179-
allOf {
180-
branch 'master'
181-
not {
182-
equals expected: 'UNSTABLE', actual: currentBuild.result
176+
parallel {
177+
stage('Master') {
178+
when {
179+
allOf {
180+
branch 'master'
181+
not {
182+
equals expected: 'UNSTABLE', actual: currentBuild.result
183+
}
184+
}
185+
}
186+
steps {
187+
npmDocsReleaseMaster()
188+
}
189+
}
190+
stage('Develop') {
191+
when {
192+
allOf {
193+
branch 'develop'
194+
not {
195+
equals expected: 'UNSTABLE', actual: currentBuild.result
196+
}
197+
}
198+
}
199+
steps {
200+
npmDocsReleaseDevelop()
183201
}
184202
}
185-
}
186-
steps {
187-
npmDocsRelease("$DOCS_BUCKET", "$DOCS_CDN")
188203
}
189204
}
190205
stage('PR Comment') {

Diff for: README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,18 @@ Password: changeme
9898
Immediately after logging in with this default user you will be asked to modify your details and change your password.
9999

100100

101-
## Contributors
101+
## Contributing
102+
103+
All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch.
104+
105+
CI is used in this project. All PR's must pass before being considered. After passing,
106+
docker builds for PR's are available on dockerhub for manual verifications.
107+
108+
Documentation within the `develop` branch is available for preview at
109+
[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com)
110+
111+
112+
### Contributors
102113

103114
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
104115

@@ -107,5 +118,4 @@ Special thanks to [all of our contributors](https://github.com/NginxProxyManager
107118

108119
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
109120
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
110-
3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community)
111-
4. [Reddit](https://reddit.com/r/nginxproxymanager)
121+
3. [Reddit](https://reddit.com/r/nginxproxymanager)

0 commit comments

Comments
 (0)