Update year in the notice file and the release process instructions (#12622)

* Update notice file

* Update release process instructions

* Better release instructions

* Update copyright year

* Web console: updated the doc link (#12619)

* updated the doc link

* update snapshots

Co-authored-by: Vadim Ogievetsky <vadim@ogievetsky.com>
This commit is contained in:
Abhishek Agarwal 2022-08-23 18:17:18 +05:30 committed by GitHub
parent a1c4eab522
commit f0fc45028e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 23 additions and 10 deletions

2
NOTICE
View File

@ -1,5 +1,5 @@
Apache Druid
Copyright 2018-2021 The Apache Software Foundation
Copyright 2018-2022 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

View File

@ -59,7 +59,7 @@ and update the script tag top level html file, [unified-console.html](../web-con
<script src="public/web-console-0.18.0.js"></script>
```
Finally, the sample [`docker-compose.yml`](https://github.com/apache/druid/blob/master/distribution/docker/docker-compose.yml) used in the Docker quickstart documentation should be updated to reflect the version for the next release:
The sample [`docker-compose.yml`](https://github.com/apache/druid/blob/master/distribution/docker/docker-compose.yml) used in the Docker quickstart documentation should be updated to reflect the version for the next release:
```yaml
...
@ -69,8 +69,15 @@ Finally, the sample [`docker-compose.yml`](https://github.com/apache/druid/blob/
...
```
`DRUID_DOCS_VERSION` has to be changed to `0.17.0` in [`links.ts`](https://github.com/apache/druid/blob/master/web-console/src/links.ts).
Once this is completed, open a PR to the master branch. Also, be sure to confirm that these versions are all correct in the release branch, otherwise fix them and open a backport PR to the release branch.
#### Updating redirect links in the docs
For docs, please make sure to add any relevant redirects in `website/redirects.json`. This has to be done before building the new website.
### Release branch hygiene
The only additions to the release branch after branching should be bug fixes, which should be back-ported from the master branch, via a second PR, not with a direct PR to the release branch. Bug fix release branches may be initially populated via cherry-picking, but it is recommended to leave at least 1 commit to do as a backport PR in order to run through CI. (Note that CI is sometimes flaky for older branches).
@ -145,7 +152,7 @@ You'll need to configure Maven with your Apache credentials by adding the follow
## LICENSE and NOTICE handling
Before cutting a release candidate, the release manager should ensure that the contents of our `LICENSE` and `NOTICE` files are up-to-date.
Before cutting a release candidate, the release manager should ensure that the contents of our `LICENSE` and `NOTICE` files are up-to-date. You should specifically check that copyright YEAR is updated in the `NOTICE` file.
The following links are helpful for understanding Apache's third-party licensing policies:
@ -248,10 +255,16 @@ must be tagged properly to make this script working. See the above [Release note
Once the release branch is good for an RC, you can build a new tag with:
```bash
$ mvn -DreleaseVersion=0.17.0 -DdevelopmentVersion=0.18.0-SNAPSHOT -Dtag=druid-0.17.0-rc3 -DpushChanges=false clean release:clean release:prepare
$ mvn -Pwebsite-docs -DreleaseVersion=0.17.0 -DdevelopmentVersion=0.18.0-SNAPSHOT -Dtag=druid-0.17.0-rc3 -DpushChanges=false clean release:clean release:prepare
```
In this example it will create a tag, `druid-0.17.0-rc3`. If this release passes vote then we can add the final `druid-0.17.0` release tag later.
In this example it will create a tag, `druid-0.17.0-rc3`. If this release passes vote then we can add the final `druid-0.17.0` release tag later.
We added `website-docs` profile, because otherwise, website module is not updated with rc version.
If you want to skip tests, you can do so with following command
```bash
$ mvn -DreleaseVersion=0.17.0 -DdevelopmentVersion=0.18.0-SNAPSHOT -Dtag=druid-0.17.0-rc3 -DpushChanges=false -DskipTests -Darguments=-DskipTests clean release:clean release:prepare
```
**Retain the release.properties file! You will need it when uploading the Maven artifacts for the final release.**

View File

@ -224,7 +224,7 @@ exports[`HeaderBar matches snapshot 1`] = `
<Blueprint4.MenuItem
active={false}
disabled={false}
href="https://druid.apache.org/docs/0.20.0"
href="https://druid.apache.org/docs/0.23.0"
icon="th"
multiline={false}
popoverProps={Object {}}

View File

@ -12,7 +12,7 @@ exports[`CoordinatorDynamicConfigDialog matches snapshot 1`] = `
Edit the coordinator dynamic configuration on the fly. For more information please refer to the
<Memo(ExternalLink)
href="https://druid.apache.org/docs/0.20.0/configuration/index.html#dynamic-configuration"
href="https://druid.apache.org/docs/0.23.0/configuration/index.html#dynamic-configuration"
>
documentation
</Memo(ExternalLink)>

View File

@ -11,7 +11,7 @@ exports[`OverlordDynamicConfigDialog matches snapshot 1`] = `
Edit the overlord dynamic configuration on the fly. For more information please refer to the
<Memo(ExternalLink)
href="https://druid.apache.org/docs/0.20.0/configuration/index.html#overlord-dynamic-configuration"
href="https://druid.apache.org/docs/0.23.0/configuration/index.html#overlord-dynamic-configuration"
>
documentation
</Memo(ExternalLink)>

View File

@ -63,7 +63,7 @@ exports[`RetentionDialog matches snapshot 1`] = `
Druid uses rules to determine what data should be retained in the cluster. The rules are evaluated in order from top to bottom. For more information please refer to the
<a
href="https://druid.apache.org/docs/0.20.0/operations/rule-configuration.html"
href="https://druid.apache.org/docs/0.23.0/operations/rule-configuration.html"
rel="noopener noreferrer"
target="_blank"
>

View File

@ -19,7 +19,7 @@
import hasOwnProp from 'has-own-prop';
// This is set to the latest available version and should be updated to the next version before release
const DRUID_DOCS_VERSION = '0.20.0';
const DRUID_DOCS_VERSION = '0.23.0';
function fillVersion(str: string): string {
return str.replace(/\{\{VERSION}}/g, DRUID_DOCS_VERSION);