diff --git a/docs/release.md b/docs/release.md index 6c9dbd8..c2b0cb5 100644 --- a/docs/release.md +++ b/docs/release.md @@ -4,8 +4,16 @@ The naming policy is based on first names for this project. -## Release list +# Release procedure +``` +bash ./scripts/release.sh -t [VERSION] -n [RELEASE_NAME] -c +edit specifique files: +- ./release/next_release.md +bash ./scripts/release.sh +``` + +## Release list - [v1.3.0 Xavier](./release/v1.3.0_xavier.md) - [v1.2.0 Valentin](./release/v1.2.0_valentin.md) - [v1.0.0 Damian](./release/v1.0.0_damian.md) diff --git a/scripts/release.sh b/scripts/release.sh index 4512ae1..cb5e6ce 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -43,6 +43,7 @@ main () { DEFINE_boolean 'create_branch' false 'Creation de la branch' 'c' DEFINE_boolean 'dryrun' false 'Enable dry-run mode' 'd' DEFINE_string 'release_path' './docs/release' 'Release path' 'p' + DEFINE_string 'doc_path' './docs/release.md' 'Documentation path' 'u' DEFINE_string 'regex_version' 'v[0-9]*.[0-9]*.[0-9]*' 'Version Regex' 'r' FLAGS "$@" || exit $? @@ -71,6 +72,8 @@ main () { echo "Release ${NAME} - ${VERSION}" echo "Edit README file" edit_file "${FLAGS_dryrun}" "sed ${SED_PARAM} 's/^${FLAGS_regex_version}: [A-Z|a-z| ]*$/${VERSION}: ${NAME}/' ./README.md" "./README.md" || return 1 + edit_file "${FLAGS_dryrun}" "sed ${SED_PARAM} '/^## Release list$/a\\ +- [${VERSION} ${NAME}](${FLAGS_release_path}/${VERSION}_${LOWER_NAME}.md)' ${FLAGS_doc_path}" "${FLAGS_doc_path}" || return 1 edit_file "${FLAGS_dryrun}" "mv '${FLAGS_release_path}/next_release.md' '${FLAGS_release_path}/${VERSION}_${LOWER_NAME}.md'" "${FLAGS_release_path}/${VERSION}_${LOWER_NAME}.md" || return 1 exec_with_dry_run "${FLAGS_dryrun}" "git commit -s -S -m 'release-${VERSION}'" || return 1 exec_with_dry_run "${FLAGS_dryrun}" "git tag '${VERSION}' -s -m 'Release ${VERSION} ${NAME}'" || return 1