Adds issue templates for other projects #829

gurkanindibay · 2021-10-07T06:32:02Z

No description provided.

hanefi

I guess you copied the checlist for Citus and assumed that there are not many changes for the other projects. Please go over them one by one and make sure they have necessary changes for each project.

.github/ISSUE_TEMPLATE/pg-auto-failover-enterprise-release-checklist-template.md

gurkanindibay · 2021-10-11T07:54:31Z

.github/workflows/build-citus-community-nightlies.yml

@@ -66,8 +66,7 @@ jobs:
          --secret_key "${PACKAGING_SECRET_KEY}" \
          --passphrase "${PACKAGING_PASSPHRASE}" \
          --output_dir "$(pwd)/packages/" \
-          --input_files_dir "$(pwd)/packaging" \
-          --output_validation
+          --input_files_dir "$(pwd)/packaging"



Removed output validation since an erronous commit made nightlies failed so the tasks failed. I think output valdation should not be null in nightlies since some warning in documentation make it failed

hanefi

Please address my comments for enterprise checklist for all applicable checklists.

Please do the following:

Remove $VERSION, $PROJECT, and $REPO references. If you decide to update the remove the information on these variables from the checklist, you should remove all the references as well.
Update the formats of all the links. [text to be shown](http://example.com) is usually nicer to read.
Move the subset of your changes that disable output validation for nightlies in a separate PR. That change is not directly related to this PR.

.github/ISSUE_TEMPLATE/citus-enterprise-release-checklist-template.md

Co-authored-by: Hanefi Onaldi <[email protected]>

This reverts commit 8440ee4.

gurkanindibay · 2021-11-25T08:39:22Z

Please address my comments for enterprise checklist for all applicable checklists.

Please do the following:

Remove $VERSION, $PROJECT, and $REPO references. If you decide to update the remove the information on these variables from the checklist, you should remove all the references as well.

Update the formats of all the links. [text to be shown](http://example.com) is usually nicer to read.

Move the subset of your changes that disable output validation for nightlies in a separate PR. That change is not directly related to this PR.

Removed $PROJECT and $REPO references but I think we shouldn't remove the $VERSION reference since this parameter is changing in each release

hanefi · 2021-11-27T01:04:39Z

@gurkanindibay I did not re-review this PR, as some of the tests are pending. FYI.

gurkanindibay · 2021-11-29T04:35:04Z

@gurkanindibay I did not re-review this PR, as some of the tests are pending. FYI.

It was task list and I intentionally left unchecked since Version reference is required I think
Now checked this task for you to be be able ro review
Thanks.

hanefi

I left reviews for enterprise checklist only. Most of the changes apply for all the templates.

Also there are ~10 lines with spacing issues. Please use a linter/autoformatter that can fix markdown files and fix those as well.

hanefi · 2021-11-29T09:00:20Z

.github/ISSUE_TEMPLATE/citus-enterprise-release-checklist-template.md

+# Update OS Packages
+## Debian and RedHat
+- Change your directory to `packaging` repository directory & checkout `all-enterprise` branch.
+- [ ] Run [this pipeline](https://github.com/citusdata/packaging/actions/workflows/update_package_properties.yml) using branch name as `all-enterprise`. Input tag name and if version is fancy, input the fancy version number. Other parameters could be kept as is if you want.


IMO, It is a nice idea to have names of the pipelines in human readable format.

Suggested change

- [ ] Run [this pipeline](https://github.com/citusdata/packaging/actions/workflows/update_package_properties.yml) using branch name as `all-enterprise`. Input tag name and if version is fancy, input the fancy version number. Other parameters could be kept as is if you want.

- [ ] Run [Update Package Properties pipeline](https://github.com/citusdata/packaging/actions/workflows/update_package_properties.yml) using branch name as `all-enterprise`. Input tag name and if version is fancy, input the fancy version number. Other parameters could be kept as is if you want.

hanefi · 2021-11-29T09:02:08Z

.github/ISSUE_TEMPLATE/citus-enterprise-release-checklist-template.md

+  - Then check the following (needed for both debian & redhat):
+    - [ ] Updated `pkglatest` variable in the `pkgvars` file to `$VERSION.citus-1`
+  - Then check the following (needed for debian):
+    - [ ] A new entry (`$VERSION.citus-1`, `stable`) is added to the `debian/changelog` file
+  - Then check the following (needed for redhat):
+    - [ ] `citus.spec` file is updated:
+      - [ ] `Version:` field
+      - [ ] `Source0:` field
+      - [ ] A new entry (`$VERSION.citus-1`) in the `%changelog` section


Does it really make sense to have different sections here?

Suggested change

- Then check the following (needed for both debian & redhat):

- [ ] Updated `pkglatest` variable in the `pkgvars` file to `$VERSION.citus-1`

- Then check the following (needed for debian):

- [ ] A new entry (`$VERSION.citus-1`, `stable`) is added to the `debian/changelog` file

- Then check the following (needed for redhat):

- [ ] `citus.spec` file is updated:

- [ ] `Version:` field

- [ ] `Source0:` field

- [ ] A new entry (`$VERSION.citus-1`) in the `%changelog` section

- Then check the following file changes:

- [ ] Updated `pkglatest` variable in the `pkgvars` file to `$VERSION.citus-1`

- [ ] A new entry (`$VERSION.citus-1`, `stable`) is added to the `debian/changelog` file

- [ ] `citus.spec` file is updated:

- [ ] `Version:` field

- [ ] `Source0:` field

- [ ] A new entry (`$VERSION.citus-1`) in the `%changelog` section

hanefi · 2021-11-29T09:04:07Z

.github/ISSUE_TEMPLATE/citus-enterprise-release-checklist-template.md

+- [ ] Get changes reviewed; merge the PR
+- [ ] Ensure Github Actions builds completed successfully and package count for each os is as below table and packages in postgres versions is compliant with `postgres-matrix.yml` in the `all-project` branch
+
+https://github.com/citusdata/tools/blob/be12af3b8f435d17a52e607c666f6b15379f5970/packaging_automation/tests/test_citus_package.py#L21-L33


What about having a human readable link with some explanation that will make it easier for the reader to understand why this is here?

If there is no reason to have it here, you can drop this line as well.

Ensure Github Actions builds completed successfully and package count for each os is as below table and packages in postgres versions is compliant with postgres-matrix.yml in the all-project branch

This is the description but it seems that it is not as definitive as I intended
What's your suggestion?

There are some issues with the current link:

The link contains a sha, and that means the link needs to be updated when new distros are introduced in the file or the package counts for a distro changed for some reason.

The tests are supposed to check the number of generated files, right? It does not make sense for an issue template to have an item that wants the user to read some piece of code, and use the values in there to check if the count of generated packages are correct.

My suggestion is to either find a better and easier alternative to this, or drop the link completely.

A possible alternative is to check the total number of packages generated, and dive deeper if the total does not match.

hanefi requested changes Oct 7, 2021

View reviewed changes

gurkanindibay requested a review from hanefi October 8, 2021 12:57

gurkanindibay commented Oct 11, 2021

View reviewed changes

hanefi requested changes Oct 11, 2021

View reviewed changes

gurkanindibay and others added 6 commits November 25, 2021 08:14

Adds issue templates for other projects

f73a0ea

Adds tag for citus packaging template

773dc5f

Apply suggestions from code review

f671a52

Co-authored-by: Hanefi Onaldi <[email protected]>

Fixes review comments

4483cb3

Apply suggestions from code review

aa2acbb

Co-authored-by: Hanefi Onaldi <[email protected]>

Revert "Removes output validation"

809948c

This reverts commit 8440ee4.

gurkanindibay force-pushed the issue_templates branch from 03da0f6 to 809948c Compare November 25, 2021 08:18

Fixes review comments

0fb8246

gurkanindibay requested a review from hanefi November 29, 2021 04:35

hanefi reviewed Nov 29, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds issue templates for other projects #829

Adds issue templates for other projects #829

gurkanindibay commented Oct 7, 2021

hanefi left a comment

gurkanindibay Oct 11, 2021

hanefi left a comment •

edited by gurkanindibay

Loading

gurkanindibay commented Nov 25, 2021 •

edited

Loading

hanefi commented Nov 27, 2021

gurkanindibay commented Nov 29, 2021 •

edited

Loading

hanefi left a comment

hanefi Nov 29, 2021

hanefi Nov 29, 2021

hanefi Nov 29, 2021

gurkanindibay Nov 29, 2021

hanefi Dec 1, 2021

	- [ ] Run [this pipeline](https://github.com/citusdata/packaging/actions/workflows/update_package_properties.yml) using branch name as `all-enterprise`. Input tag name and if version is fancy, input the fancy version number. Other parameters could be kept as is if you want.
	- [ ] Run [Update Package Properties pipeline](https://github.com/citusdata/packaging/actions/workflows/update_package_properties.yml) using branch name as `all-enterprise`. Input tag name and if version is fancy, input the fancy version number. Other parameters could be kept as is if you want.

Adds issue templates for other projects #829

Are you sure you want to change the base?

Adds issue templates for other projects #829

Conversation

gurkanindibay commented Oct 7, 2021

hanefi left a comment

Choose a reason for hiding this comment

gurkanindibay Oct 11, 2021

Choose a reason for hiding this comment

hanefi left a comment • edited by gurkanindibay Loading

Choose a reason for hiding this comment

gurkanindibay commented Nov 25, 2021 • edited Loading

hanefi commented Nov 27, 2021

gurkanindibay commented Nov 29, 2021 • edited Loading

hanefi left a comment

Choose a reason for hiding this comment

hanefi Nov 29, 2021

Choose a reason for hiding this comment

hanefi Nov 29, 2021

Choose a reason for hiding this comment

hanefi Nov 29, 2021

Choose a reason for hiding this comment

gurkanindibay Nov 29, 2021

Choose a reason for hiding this comment

hanefi Dec 1, 2021

Choose a reason for hiding this comment

hanefi left a comment •

edited by gurkanindibay

Loading

gurkanindibay commented Nov 25, 2021 •

edited

Loading

gurkanindibay commented Nov 29, 2021 •

edited

Loading