phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc] Use new javadoc location from https://docs.pmd-code.org

Browse Source 
Note: the version now needs SNAPSHOT, so that the javadoc links
work on master. This is not available, if javadoc.io is used.
This commit is contained in:
Andreas Dangel
2020-04-14 17:40:29 +02:00
parent 727c398326
commit 92466ebd28
3 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/_config.yml
View File

@ -1,7 +1,7 @@
repository: pmd/pmd
pmd:
version: 6.23.0
version: 6.23.0-SNAPSHOT
previous_version: 6.22.0
date: ??-??-2020
release_type: minor
@ -115,3 +115,7 @@ description: "Intended as a documentation theme based on Jekyll for technical wr
# needed for sitemap.xml file only
url: https://pmd.github.io/pmd
baseurl: ""
# used by javadoc_tag.rb
# https://javadoc.io/page/net.sourceforge.pmd
javadoc_url_prefix: https://docs.pmd-code.org/apidocs

6
docs/_plugins/javadoc_tag.rb
View File

@ -151,13 +151,13 @@ class JavadocTag < Liquid::Tag
api_version = var_ctx["site.pmd." + (@use_previous_api_version ? "previous_version" : "version")]
markup_link(visible_name, doclink(artifact_name, api_version, @type_fqcn, @member_suffix))
markup_link(visible_name, doclink(var_ctx["site.javadoc_url_prefix"], artifact_name, api_version, @type_fqcn, @member_suffix))
end
private
def doclink(artifact, api_version, type_name, member_suffix)
"https://javadoc.io/page/net.sourceforge.pmd/#{artifact}/#{api_version}/#{type_name.gsub("\.", "/")}.html##{member_suffix}"
def doclink(url_prefix, artifact, api_version, type_name, member_suffix)
"#{url_prefix}/#{artifact}/#{api_version}/#{type_name.gsub("\.", "/")}.html##{member_suffix}"
end
def markup_link(rname, link)

27
docs/pages/pmd/projectdocs/committers/releasing.md
View File

@ -27,13 +27,14 @@ Make sure code is up to date and everything is committed and pushed with git:
You can find the release notes here: `docs/pages/release_notes.md`.
The date and the version must be updated in `docs/_config.yml`, e.g.
The date (`date +%d-%B-%Y`) and the version (remove the SNAPSHOT) must be updated in `docs/_config.yml`, e.g.
```
pmd:
version: 6.0.0
date: 2017-12-15
release_type: major
version: 6.22.0
previous_version: 6.21.0
date: 12-March-2020
release_type: minor
```
The release type could be one of "bugfix", "minor", or "major".
@ -67,13 +68,13 @@ The new version needs to be entered into `_config.yml`, e.g.:
```
pmd:
latestVersion: 6.0.0
latestVersionDate: 15th December 2017
latestVersion: 6.22.0
latestVersionDate: 12-March-2020
```
Also move the previous version down into the "downloads" section.
Then create a new page for the new release, e.g. `_posts/2017-12-15-PMD-6.0.0.md` and copy
Then create a new page for the new release, e.g. `_posts/2020-03-12-PMD-6.22.0.md` and copy
the release notes into this page. This will appear under the news section.
Check in all (version) changes to branch master:
@ -112,6 +113,7 @@ it is a tag build and a released version build, travis-ci will do a couple of ad
selected as the new default downloads for PMD.
* Add the documentation of the new release to a subfolder on <https://pmd.github.io>, also make
this folder available as `latest`.
* Upload the documentation to <https://docs.pmd-code.org>.
## After the release
@ -146,7 +148,16 @@ the following template:
### Prepare the new release notes
* Update version in **docs/_config.yml**
* Update version in **docs/_config.yml**. Note - the next version needs to have a SNAPSHOT in it.
```
pmd:
version: 6.23.0-SNAPSHOT
previous_version: 6.22.0
date: ??-??-2020
release_type: minor
```
* Move version/release info from **docs/pages/release_notes.md** to **docs/pages/release_notes_old.md**.
* Update version/release info in **docs/pages/release_notes.md**. Use the following template: