docs: trimmed post_install_message in cpflow.gemspec

[PandaBean18]

Fixes #377

Summary

Trims the 17-line post_install_message in cpflow.gemspec down to a concise notification pointing to the official documentation.

Changes

• Condensed the installation message in cpflow.gemspec to keep terminal output clean upon gem install/upgrade.
• Preserved the note for users with generated GitHub Actions workflows (cpflow update-github-actions).
• Added a link to the official documentation portal: https://shakacode.com/control-plane-flow/docs/.

Verification

• Ran gem build cpflow.gemspec to verify the gemspec builds cleanly without syntax errors.
• Ran bundle exec rubocop cpflow.gemspec with 0 offenses detected.

Summary by CodeRabbit

• Documentation
  • Updated the post-install guidance to direct users to run cpflow update-github-actions after upgrading when generated GitHub Actions are used.
  • Added a documentation link with instructions for updating generated workflows.
  • Removed outdated guidance and cleaned up stale specifications.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fa516a3f-d941-454e-a134-08d687324599

📥 Commits

Reviewing files that changed from the base of the PR and between 6496566 and e6f4507.

📒 Files selected for processing (3)

• CHANGELOG.md
• cpflow.gemspec
• spec/cpflow_spec.rb

---

Walkthrough

The post-install message now provides concise guidance for updating generated GitHub Actions, the spec checks for the documentation URL, and the changelog records the change.

Changes

Post-install guidance

Layer / File(s)	Summary
Post-install guidance and validation cpflow.gemspec, spec/cpflow_spec.rb, CHANGELOG.md	The post-install message was shortened to the update command and documentation URL, the spec expectation was updated accordingly, and the unreleased changelog records the change.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: justin808

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Linked Issues check	❓ Inconclusive	The banner, spec, and changelog were updated, but the PR doesn't show the removed guidance moved into the linked docs page.	Add the docs update (or link to it) containing the removed guidance, including the Bundler and new-repo flows.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately summarizes the main change to cpflow.gemspec's post-install message.
Description check	✅ Passed	The description covers the summary, related issue, and validation, with only the checklist section missing.
Out of Scope Changes check	✅ Passed	The changes stay focused on the install message, its spec, and the changelog, with no unrelated edits.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[greptile-apps]

Greptile Summary

This PR shortens the gem installation notice. The main changes are:

• Replaces detailed upgrade and verification steps with one command.
• Removes first-time setup guidance.
• Adds a link to the official documentation.

Confidence Score: 4/5

The stale post-install-message test needs to be updated before merging.

• The existing spec still requires text removed by this change.
• Bundler users can run a globally installed cpflow version and generate workflows from stale templates.

cpflow.gemspec and spec/cpflow_spec.rb

Important Files Changed

Filename	Overview
cpflow.gemspec	Shortens the post-install message, but leaves an existing test stale and removes Bundler-specific command guidance.

_{Reviews (1): Last reviewed commit: "docs: trimmed post_install_message in cp..." | Re-trigger Greptile}

[greptile-apps]

Post-Install Spec Still Expects Removed Text

The existing post-install-message spec still expects bin/test-cpflow-github-flow, which this line removes. The test suite will fail until that expectation is updated to match the intentionally shortened message.

[greptile-apps]

Bundler Upgrade Can Use Wrong Version

In a Bundler-managed repository, plain cpflow can resolve to a different globally installed version instead of the version in Gemfile.lock. The update command then copies that version's templates, potentially leaving generated workflows pinned to the wrong release.

Suggested change

	If this repo uses generated cpflow GitHub Actions, run cpflow update-github-actions after upgrading.
	If this repo uses generated cpflow GitHub Actions, run cpflow update-github-actions after upgrading.
	Bundler users should run bundle exec cpflow update-github-actions.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

[justin808]

Thanks—this is aligned with #377, and the latest commit updates the stale spec while retaining the Bundler command.

Before merging, please address the remaining acceptance criteria:

1. Add an entry under CHANGELOG.md → Unreleased → Changed for this user-visible install-output change.
2. Link directly to the generated-actions update guidance (https://shakacode.com/control-plane-flow/docs/ci-automation/#updating-generated-github-actions-after-gem-updates) rather than the general docs homepage, so the detailed commands removed from the install message remain one click away.

Once those are addressed and CI is green, this should be ready.

[PandaBean18]

good evening @justin808, I have addressed the requested changes, would like a review,

regards,

[justin808]

@PandaBean18 Can you tell me what company or website you're using Control Plane for?

[PandaBean18]

@PandaBean18 Can you tell me what company or website you're using Control Plane for?

Hey @justin808, I havent really used control plane, I am a college student but I have been working with ruby and ruby on rails since I was in high school and really wanted to give back to the community. I came across control plane flow while searching for open source ruby projects to contribute to.