Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/creadur-site
Apache Creadur website
https://github.com/apache/creadur-site
creadur
Last synced: 4 days ago
JSON representation
Apache Creadur website
- Host: GitHub
- URL: https://github.com/apache/creadur-site
- Owner: apache
- Created: 2016-09-10T07:00:07.000Z (about 8 years ago)
- Default Branch: asf-site
- Last Pushed: 2024-09-24T08:09:44.000Z (9 days ago)
- Last Synced: 2024-09-25T15:46:41.381Z (8 days ago)
- Topics: creadur
- Language: HTML
- Homepage: https://creadur.apache.org/
- Size: 17.5 MB
- Stars: 2
- Watchers: 11
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Apache Creadur Website
This project contains the project's webpage.
Its deployment is done via [asf.yaml](./.asf.yaml). Every commit is directly pushed and available on https://creadur.apache.org/
## How to generate new page versions for RAT
## SNAPSHOT
The current SNAPSHOT version of RAT can be found in [rat017](https://creadur.apache.org/rat017/) and is generated manually.
### RAT
In order to sync the current webpage (taken from current SNAPSHOT) you need to run the following commands:
```
$ cd creadur-rat
$ mvn clean site:site site:stage
$ cd ../creadur-site
$ cp -rvf ../creadur-rat/target/staging/* ./rat/
Make sure to manually adapt download pages as they need to reference the current release and SNAPSHOT versions!
$ git commit -am "Update site build for RAT"
```
*WARNING!* This will sync the current master branch/SNAPSHOT version of the homepage if not run on the release branch
Have a look in [RAT's buildtools folder](https://github.com/apache/creadur-rat/tree/master/.buildtools) if you want to generate a preview webpage.
### Tentacles
Same, but:
```
$ cd creadur-tentacles
$ mvn clean site:site site:stage
$ cd ../creadur-site
$ cp -rvf ../creadur-tentacles/target/staging/* ./tentacles/
Make sure to manually adapt download pages as they need to reference the current release and SNAPSHOT versions!
$ git commit -am "Update site build for TENTACLES"
```
Have a look in [TENTACLES' buildtools folder](https://github.com/apache/creadur-tentacles/tree/master/.buildtools) if you want to generate a preview webpage.
### Whisker
Same, but:
```
$ cd creadur-whisker
$ mvn clean site:site site:stage
$ cd ../creadur-site
$ cp -rvf ../creadur-whisker/target/staging/* ./whisker/
Make sure to manually adapt download pages as they need to reference the current release and SNAPSHOT versions!
$ git commit -am "Update site build for WHISKER"
```
Have a look in [WHISKER's buildtools folder](https://github.com/apache/creadur-whisker/tree/master/.buildtools) if you want to generate a preview webpage.
## Releases
Due to problems when generating Javadoc do only use JDK16! Newer versions run into NPE during path traversal.
It may happen that you need access to the original release candidate JARs in order to have all of the necessary test JARs to perform a site build,
see [RAT-341](https://issues.apache.org/jira/browse/RAT-341) for details. As a workaround copy these files into your local .m2 repository and run a site build:
```
$ mvn site:site site:stage
```
```
$ cd creadur-rat
$ git checkout apache-rat-project-0.16.1
$ mvn clean site:site site:stage
Verify contents under target/staging
$ cd ../creadur-site
$ mkdir rat016
$ cp -rvf ../creadur-rat/target/staging/* ./rat0161/
Make sure to manually adapt download pages as they need to reference the current release and SNAPSHOT versions!
$ git commit -am "Push new preview version of RAT 0.16.1"
```
This will allow a preview of the release site build at [rat0161](./rat0161)
### Release Notes / RAT-306
Make sure that https://creadur.apache.org/rat/RELEASE_NOTES.txt does not yield a 404.
RAT's changelog consists of 2 versions:
* [generated changelog of the current release](https://github.com/apache/creadur-rat/blob/master/RELEASE-NOTES.txt)
* [complete/historical changelog](https://github.com/apache/creadur-rat/blob/master/RELEASE_NOTES.txt)
Usually it helps to copy over the release-generated version into the subfolder /rat of this project
### Combined release notes
Make sure to generate a combined changelog that includes the most current release, available under [relase-notes/rat.txt](/release-notes/rat.txt)