Skip to content

Sitepod Release Process

Jump to bottom
Lewis John McGibbney edited this page Feb 8, 2018 · 3 revisions

Release HOWTO

The following document should be followed for anyone wishing to release Sitepod.

Update inc/Ontology.php

Ensure to update the PSNG_VERSION constant in inc/Ontology.php to the version you want to release. Note, this needs to contain semantic versioning e.g. 1.5.3

Update sonar.projectVersion

Update sonar.projectVersion value in sonar-project.properties

Ensure composer.json composer.json is valid

Run composer validate, address any issues.

Create a Tag for the Release

Create a tag with the following command

git tag -a <VERSION> -m "Sitepod <VERSION>"

Push the tag to remote Github server

git push --tags

This should be it... new versions of Sitepod are automatically fetched from tags you create in your VCS repository.

Tag/version names should match 'X.Y.Z', or 'vX.Y.Z', with an optional suffix for RC, beta, alpha or patch versions. Here are a few examples of valid tag names:

  • 1.0.0
  • v1.0.0
  • 1.10.5-RC1
  • v4.4.4beta2
  • v2.0.0-alpha
  • v2.0.4-p1

Branches will automatically appear as "dev" versions that are easily installable by anyone that wants to try Sitepod's latest and greatest, but that does not mean you should not tag releases. The use of Semantic Versioning is strongly encouraged.

Conclusion

If all went well, you've successfully released Sitepod. Please announce the following release to the following channels

TO: opendev <opendev@jpl.nasa.gov>; podaac-all <podaac-all@jpl.nasa.gov>; opensource <opensource@jpl.nasa.gov>; opensource@lists.nasa.gov <opensource@lists.nasa.gov>; esdswg-search@lists.nasa.gov <esdswg-search@lists.nasa.gov>

TOPIC: [ANNOUNCEMENT] Sitepod 1.5.3 Released

Hi Folks,

We are happy to announce release and immediate availability of Sitepod [0] 1.5.3

What is Sitepod?
A Sitemap Generator written in PHP.

How can I install Sitepod?
Sitepod is available through the Composer package manager for PHP, more information can be found at [1].

Community
Please report any issues to the Sitepod issue tracker at [2].

License
Sitepod is licensed as free software under the GPLv3 license, more information can be found at [3].

Best
Lewis

[0] https://github.com/nasa/sitepod
[1] https://github.com/nasa/sitepod#installation-fro-package-manager-composer
[2] https://github.com/nasa/sitepod#community-support-and-development
[3] https://github.com/nasa/sitepod#license
Clone this wiki locally