Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(PE-37235) Verify and update documentation on add_compiler #429

Merged
merged 10 commits into from
Aug 21, 2024
Merged

(PE-37235) Verify and update documentation on add_compiler #429

merged 10 commits into from
Aug 21, 2024

Conversation

cathal41
Copy link
Contributor

@cathal41 cathal41 commented Apr 12, 2024 •
edited by ragingra
Loading

Adding new documentation page for the new add compiler plan

Additional Context

N/A

Related Issues (if any)

N/A

Checklist

  • 🟢 Spec tests.
  • 🟢 Acceptance tests.

Changes include test coverage?

  • Yes
  • Not needed

Have you updated the documentation?

  • Yes, I've updated the appropriate docs
  • Not needed

@cathal41 cathal41 requested review from a team as code owners April 12, 2024 10:55
timidri
timidri requested changes Apr 14, 2024
View reviewed changes
Copy link
Contributor

@timidri timidri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General comment: I was under the impression that peadm::add_compiler was supposed to support both compilers with and without puppetdb, so peadm::add_compiler can be used by customers who have compilers without puppetdb on them.

documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
@timidri timidri requested a review from J-Hunniford April 14, 2024 22:50
@cathal41
@cathal41
49c309b 
PE-37235 Verify and update documentation on add_compiler - wording updates
timidri
timidri requested changes Apr 15, 2024
View reviewed changes
documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
plans/add_compiler.pp Outdated Show resolved Hide resolved
cathal41 and others added 6 commits April 15, 2024 11:59
@cathal41 @timidri
Update plans/add_compiler.pp
495ec7a 
Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
@cathal41 @timidri
Update documentation/add_compiler.md
b9d3090 
Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
@cathal41 @timidri
Update documentation/add_compiler.md
c22656e 
Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
@cathal41 @timidri
Update documentation/add_compiler.md
be239b3 
Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
@cathal41 @timidri
Update documentation/add_compiler.md
3bfa284 
Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
@cathal41 @timidri
Update documentation/add_compiler.md
532f434 
Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
J-Hunniford
J-Hunniford requested changes Apr 17, 2024
View reviewed changes
Copy link
Contributor

@J-Hunniford J-Hunniford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cathal41 First pass done. Mostly suggestions for minor edits. Line 27 will need a bit of reworking. Have left some questions there.

documentation/add_compiler.md Show resolved Hide resolved
documentation/add_compiler.md Show resolved Hide resolved
documentation/add_compiler.md Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
documentation/add_compiler.md Outdated Show resolved Hide resolved
plans/add_compiler.pp Outdated Show resolved Hide resolved
@cathal41 cathal41 marked this pull request as draft April 25, 2024 10:36
@ragingra ragingra changed the title PE-37235 Verify and update documentation on add_compiler if needed and its experimental status (PE-37235) Verify and update documentation on add_compiler Jul 29, 2024
@ragingra ragingra changed the base branch from main to add_compiler_supported July 30, 2024 08:47
@ragingra
Copy link
Member

General comment: I was under the impression that peadm::add_compiler was supposed to support both compilers with and without puppetdb, so peadm::add_compiler can be used by customers who have compilers without puppetdb on them.

@timidri This will be included as part of the legacy compiler work which is still work-in-progress

@ragingra ragingra marked this pull request as ready for review July 30, 2024 10:02
@ragingra ragingra force-pushed the PE_37235_addCompiler_doc branch from eddc54c to 869fc70 Compare July 30, 2024 10:31
@CoMfUcIoS
Copy link
Contributor

Hey @timidri and @J-Hunniford, can we have another look on this PR please? Any other concerns, comments?

@CoMfUcIoS CoMfUcIoS merged commit d8ced09 into add_compiler_supported Aug 21, 2024
4 checks passed
@CoMfUcIoS CoMfUcIoS deleted the PE_37235_addCompiler_doc branch August 21, 2024 09:33
CoMfUcIoS pushed a commit that referenced this pull request Sep 2, 2024
@cathal41 @timidri
@ragingra @CoMfUcIoS
(PE-37235) Verify and update documentation on add_compiler (#429)
f1af323 
* PE-37235 Verify and update documentation on add_compiler if needed and its experimental status

* @cathal41
PE-37235 Verify and update documentation on add_compiler - wording updates

* Update plans/add_compiler.pp

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Updating add compiler docs to show optional params

* Updating docs with text corrections

---------

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
Co-authored-by: Neil Anderson <neil.anderson@perforce.com>
CoMfUcIoS pushed a commit that referenced this pull request Sep 9, 2024
@cathal41 @timidri
@ragingra @CoMfUcIoS
(PE-37235) Verify and update documentation on add_compiler (#429)
08ffb6a 
* PE-37235 Verify and update documentation on add_compiler if needed and its experimental status

* @cathal41
PE-37235 Verify and update documentation on add_compiler - wording updates

* Update plans/add_compiler.pp

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Updating add compiler docs to show optional params

* Updating docs with text corrections

---------

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
Co-authored-by: Neil Anderson <neil.anderson@perforce.com>
CoMfUcIoS added a commit that referenced this pull request Sep 12, 2024
@CoMfUcIoS @Jo-Lillie
@ragingra @cathal41 @timidri
(PE-37233-35) Official support of Add compiler plan (#485)
68329f0 
* (PE-37236) Remove experimental status of add_compiler (#428)

* (PE-37233) Adding add_compiler to test matrix (#434)

Updated add_compiler spec to check compiler has been added and puppet run before running add compiler
Added test matrix for add compiler

* (PE-38814) add_compiler - Making primary_postgresql_host and avail_group_letter optional (#468)

* (PE-38814) add_compiler - Making primary_postgresql_host and avail_group_letter optional

primary_postgresql_host, if not provided will be determined through get_peadm_config
avail_group_letter, is defaulting to A

* Updating spec tests for add compiler

Removing optional from avail_group_letter as not required with enum default value

* Updating reference.md

* Fixing linting issues

---------

Co-authored-by: Neil Anderson <neil.anderson@perforce.com>

* (PE-37235) Verify and update documentation on add_compiler (#429)

* PE-37235 Verify and update documentation on add_compiler if needed and its experimental status

* @cathal41
PE-37235 Verify and update documentation on add_compiler - wording updates

* Update plans/add_compiler.pp

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Update documentation/add_compiler.md

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>

* Updating add compiler docs to show optional params

* Updating docs with text corrections

---------

Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
Co-authored-by: Neil Anderson <neil.anderson@perforce.com>

* chore(workflows): simplify YAML syntax and improve readability

- Removed unnecessary quotes around strings in YAML files.
- Consolidated list items to single-line format where applicable.
- Ensured consistent naming conventions for job steps.
- Improved readability by removing extra blank lines.

* fix(workflow): add console_password to test-add-compiler workflows

- Added `console_password` parameter to the `test-add-compiler-matrix.yml` and `test-add-compiler.yaml` workflows.
- This ensures the console password is passed correctly during the workflow execution.

* chore: update test-add-compiler-matrix workflow

- Remove centos-7 from the image matrix in test-add-compiler-matrix.yml
- Retain only almalinux-cloud/almalinux-8 in the image matrix

* feat(workflow): add --stream option to bolt plan run command

Added the --stream option to the bolt plan run command in the test-add-compiler GitHub workflow. This change ensures that the output is streamed in real-time.

* chore(workflow): update compiler versions in test-add-compiler-matrix.yml

Updated the compiler versions in the test-add-compiler-matrix.yml GitHub workflow from 2021.7.7 and 2023.6.0 to 2021.7.9 and 2023.8.0.

---------

Co-authored-by: Jo Lillie <jo.lillie@puppet.com>
Co-authored-by: Neil Anderson <ragingra@users.noreply.github.com>
Co-authored-by: Neil Anderson <neil.anderson@perforce.com>
Co-authored-by: cathal41 <62099613+cathal41@users.noreply.github.com>
Co-authored-by: Dimitri Tischenko <1586813+timidri@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bastelfreak bastelfreak bastelfreak left review comments

@ragingra ragingra ragingra left review comments

@CoMfUcIoS CoMfUcIoS CoMfUcIoS approved these changes

@timidri timidri Awaiting requested review from timidri

@davidsandilands davidsandilands Awaiting requested review from davidsandilands

@J-Hunniford J-Hunniford Awaiting requested review from J-Hunniford

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@cathal41 @ragingra @CoMfUcIoS @bastelfreak @timidri @davidsandilands @J-Hunniford