Skip to content

Commit

Permalink
Merge branch 'master' into release-strategy
Browse files Browse the repository at this point in the history
  • Loading branch information
jenriquesoriano authored May 11, 2020
2 parents 83c10cf + 08c2d0a commit 93d4cb4
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 361 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ The status of the solutions to all the issues currently open in the helpdesk can

Please note that the helpdesk should not be used to report generic issues with INSPIRE implementation, but only to report problems of the Validator (i.e. tests that are/might not be currently implemented or issues to the web application) and to collect improvement proposals.

See the [changelog](changelog.md) and the [release planning](release_planning.md) for the current features and the future development/release plans for the ATS & ETS development corresponding to the [Staging instance](http://staging-inspire-validator.eu-west-1.elasticbeanstalk.com/etf-webapp/) and the [Production instance](http://inspire.ec.europa.eu/validator) of the INSPIRE Reference Validator. For the roadmap of the ETF software, refer to the [project board](https://github.com/orgs/etf-validator/projects/2) of the ETF-Validator project.
Please check the [changelog of the current and past releases](https://github.com/inspire-eu-validation/community/releases) and the [release planning strategy](https://github.com/inspire-eu-validation/community/tree/master/release%20strategy) for the plan of future releases of the INSPIRE Reference Validator.
255 changes: 0 additions & 255 deletions changelog.md

This file was deleted.

48 changes: 24 additions & 24 deletions release strategy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
- [Release Planning](#release-planning)
* [Instances of the INSPIRE Reference Validator](#instances-of-the-inspire-reference-validator)
* [Annual releases](#annual-releases)
* [v2020.1 - 15/03/2020](#v20201---15-03-2020)
* [v2020.2 - 15/06/2020](#v20202---15-06-2020)
* [v2020.3 - 15/09/2020](#v20203---15-09-2020)
* [v2021.0 - 15/01/2021](#v20210---15-01-2021)
* [v2020.1 - 15/03/2020](#v20201-15-03-2020)
* [v2020.2 - 15/06/2020](#v20202-15-06-2020)
* [v2020.3 - 15/09/2020](#v20203-15-09-2020)
* [v2021.0 - 15/01/2021](#v20210-15-01-2021)
- [Release Delivery](#release-delivery)

# Introduction
Expand Down Expand Up @@ -36,7 +36,7 @@ Multiple instances of the INSPIRE Reference Validator are currently available (o

## Annual releases

As mentioned above, several releases of the INSPIRE Reference Validator are scheduled each year with the main goal of concentrating breaking changes in the first half of the year in order to produce the major release used for the end-of-year Monitoring process already in June. The scheduled annual releases are described in detail in the next sub-sections. In addition to the different infrastructure and deployment environments, the different releases are managed using different branches of the [_ets-repository_ repository](https://github.com/inspire-eu-validation/ets-repository).
As mentioned above, several releases of the INSPIRE Reference Validator are scheduled each year with the main goal of concentrating breaking changes in the first half of the year in order to produce the major release used for the end-of-year Monitoring process already in June. The scheduled annual releases are described in detail in the next sub-sections. In addition to the different infrastructure and deployment environments, the different releases are managed using different branches of the [_ets-repository_](https://github.com/inspire-eu-validation/ets-repository) repository.

For simplicity, the descriptions make explicit reference to releases in the years 2020/2021, but the same release schedule will be applied consistently over the following years:

Expand All @@ -47,46 +47,46 @@ For simplicity, the descriptions make explicit reference to releases in the year
* **v2021.0 - 15/01/2021**: it includes both breaking and non-breaking changes, including those available in the beta instance of the previous year.

### v2020.1 - 15/03/2020
This release is scheduled for 15/03/2020 and includes breaking and non-breaking changes. All these changes (each managed in a dedicated branch) are first incorporated in the _staging_ branch, i.e. they are made available in the Staging instance, and afterwards also in the _v2020.1_ branch. This branch is finally merged into the _master_ branch, which will make all changes available in the Production instance. Should hotfixes be needed at any time, they are immediately incorporated both in the _staging_ and the _master_ branches.
This release is scheduled for 15/03/2020 and includes breaking and non-breaking changes. All these changes (each managed in a dedicated branch) are first incorporated in the _staging_ branch, i.e. they are made available in the Staging instance; afterwards, each change which is also tested and accepted by the user who originally reported it, is also incorporated in the _v2020.1_ branch. This branch is finally merged into the _master_ branch, which will make all changes available in the Production instance. Should hotfixes be needed at any time, they are immediately incorporated both in the _staging_ and the _master_ branches.

![v2020.1](./img/v2020.1.png "v2020.1")

### v2020.2 - 15/06/2020
This release is scheduled for 15/06/2020 and includes breaking and non-breaking changes. All these changes (each managed in a dedicated branch) are first incorporated in the _staging_ branch, i.e. they are made available in the Staging instance, and afterwards also in the _v2020.2_ branch. This branch is finally merged into the _master_ branch, which will make all changes available in the Production instance, and also in the _beta_ branch. Should hotfixes be needed at any time, they are immediately incorporated both in the _staging_ and the _master_ branches. <!-- check how hotfixes are addressed: is there a need to create a v.2020.1.1 branch? If yes, update description. -->
This release is scheduled for 15/06/2020 and includes breaking and non-breaking changes. All these changes (each managed in a dedicated branch) are first incorporated in the _staging_ branch, i.e. they are made available in the Staging instance; afterwards, each change which is also tested and accepted by the user who originally reported it, is also incorporated in the _v2020.2_ branch. This branch is finally merged into the _master_ branch, which will make all changes available in the Production instance, and also in the _beta_ branch. Should hotfixes be needed at any time, they are immediately incorporated both in the _staging_ and the _master_ branches.

![v2020.2](./img/v2020.2.png "v2020.2")

### v2020.3 - 15/09/2020
This release is scheduled for 15/09/2020 and only includes non-breaking changes. All these changes (each managed in a dedicated branch) are first incorporated in the _staging_ branch, i.e. they are made available in the Staging instance, and afterwards also in the _v2020.3_ branch. This branch is finally merged into the _master_ branch, which will make all changes available in the Production instance. Conversely, in addition to the non-breaking changes, breaking changes (each managed in a dedicated branch) are also incorporated in the _beta_ branch. Should hotfixes be needed at any time, they are immediately incorporated both in the _staging_, the _master_ and the _beta_ branches. <!-- check how hotfixes are addressed: is there a need to create a v.2020.2.1 branch? If yes, update description. -->
This release is scheduled for 15/09/2020 and only includes non-breaking changes. All these changes (each managed in a dedicated branch) are first incorporated in the _staging_ branch, i.e. they are made available in the Staging instance; afterwards, each change which is also tested and accepted by the user who originally reported it, is also incorporated in the _v2020.3_ branch. This branch is finally merged into the _master_ branch, which will make all changes available in the Production instance. Conversely, in addition to the non-breaking changes, breaking changes (each managed in a dedicated branch) are also incorporated in the _beta_ branch. Should hotfixes be needed at any time, they are immediately incorporated both in the _staging_, the _master_ and the _beta_ branches.

![v2020.3](./img/v2020.3.png "v2020.3")

### v2021.0 - 15/01/2021
This release is scheduled for 15/01/2021 and includes breaking and non-breaking changes. All these changes (each managed in a dedicated branch) are progressively incorporated in the _beta_ branch, and finally also in the _v2021.0_ branch. This branch is finally merged into the _staging_ and the _master_ branches, which will make all changes available in both the Staging and the Production instances. Should hotfixes be needed at any time, they are immediately incorporated in both the _staging_ and the _master_ branches. <!-- check how hotfixes are addressed: is there a need to create a v.2020.3.1 branch? If yes, update description. -->
This release is scheduled for 15/01/2021 and includes breaking and non-breaking changes. All these changes (each managed in a dedicated branch) are progressively incorporated in the _beta_ branch, and finally also in the _v2021.0_ branch. This branch is finally merged into the _staging_ and the _master_ branches, which will make all changes available in both the Staging and the Production instances. Should hotfixes be needed at any time, they are immediately incorporated in both the _staging_ and the _master_ branches.

![v2021.0](./img/v2021.0.png "v2021.1")



As mentioned above, this release schedule has been made to cover an annual cycle as an example, but this release schedule is intended to be established consistently over time.
As mentioned above, this release schedule only covers the annual cycle 2020/2021 as a reference example, but it will be also applied consistently in each of the following years.

# Release Delivery
Each release of the INSPIRE Reference Validator is fully managed and made available to the INSPIRE community through the folowing set of GitHub artifacts:
Each release of the INSPIRE Reference Validator is fully managed and made available to the INSPIRE community through the following set of GitHub artifacts:

* a **GitHub milestone**, named _v202x.y (dd/mm/yyyy)_ and published on the [Milestones section of the _community_ repository](https://github.com/inspire-eu-validation/community/milestones); the milestone lists the issues whose solutions are included in the current release;
* a **GitHub milestone**, named _v202x.y (dd/mm/yyyy)_ and published on the [Milestones section of the _community_ repository](https://github.com/inspire-eu-validation/community/milestones); the milestone lists the issues whose solutions are included in the corresponding _v202x.y (dd/mm/yyyy)_ release;

* a **GitHub release**, named _v202x.y (dd/mm/yyyy)_ and published on the [Release section of the _community_ repository](https://github.com/inspire-eu-validation/community/releases). The release notes include:
* a list of new features to the ATS, ETS and ETF
* a list of bugfixes, each with the corresponding issue and pull request
* a list of the enhancements, each with the corresponding issue and pull request
* the new documentation produced, if any
* assets, i.e. code packages required for deployment:
* _ets-repository-v202x.y.zip_, containing the _ets-repository_ repository corresponding to the release branch;
* _etf-release-v202x.y.zip_, containing ETF deployment instructions and artifacts;
* _Source code.zip_ and _Source code.tar.gz_, including the content of the _community_ repository for the current release;
- a list of new features to the ATS, ETS and ETF
- a list of bugfixes, each with the corresponding issue and pull request
- a list of the enhancements, each with the corresponding issue and pull request
- the new documentation produced, if any
- assets, i.e. code packages required for deployment:
- _ets-repository-v202x.y.zip_, containing the _ets-repository_ repository corresponding to the release branch;
- _etf-release-v202x.y.zip_, containing ETF deployment instructions and artifacts;
- _Source code.zip_ and _Source code.tar.gz_, including the content of the _community_ repository for the current release;

* a **GitHub package**, published on the [Packages section of the _community_ repository](https://github.com/inspire-eu-validation/community/packages), including the instructions and resources needed to deploy the current release of the INSPIRE Reference Validator through the use of Docker.
* a **GitHub package**, published on the [Packages section of the _community_ repository](https://github.com/inspire-eu-validation/community/packages), including the instructions and resources needed to deploy the corresponding release of the INSPIRE Reference Validator through the use of Docker.


* update of the **[GitHub issue tracker of the _community_ repository](https://github.com/inspire-eu-validation/community/issues)** by changing the label of the issues solved within the corresponding release from _solved_ to _deployed in reference validator_ and by closing them;

* update of the **[GitHub issue tracker of the _community_ repository](https://github.com/inspire-eu-validation/community/issues)** by changing the label of the issues solved within the current release from _solved_ to _deployed in reference validator_ and by closing them;

* update of the **[Validator issues project board](https://github.com/inspire-eu-validation/community/projects/1)** by moving all the issues labeled as _deployed in reference validator_ to the column _Production: latest release_.
Binary file modified release strategy/img/v2020.1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified release strategy/img/v2020.2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified release strategy/img/v2020.3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified release strategy/img/v2021.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 0 additions & 81 deletions release_planning.md

This file was deleted.

0 comments on commit 93d4cb4

Please sign in to comment.