UI: hackweek: add copilot instructions to ui repo #31361

beagins · 2025-07-23T18:13:41Z

Description

What does this PR do?
Hackweek: add copilot instructions to ui repo

Work with Vault UI team to come up with ember js/ts/hbs/scss/test instructions for automated copilot PR reviews.
GoLang instructions shamelessly copied from Niko's shared HashiCorp copilot-resources repo
GitHub Copilot Reviewer Demo using this set of instructions

github-actions · 2025-07-23T18:43:10Z

CI Results:
All Go tests succeeded! ✅

vercel · 2025-07-23T23:48:17Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
vault-ui	Ready	Preview	Comment	Aug 18, 2025 4:59pm

nikolasrieble · 2025-07-25T05:18:38Z

.github/copilot-instructions.md

@@ -0,0 +1,265 @@
+# GitHub Copilot Instructions for Vault


👋 Great to see the adoption of instructions. I spent the full HackWeek on investigating instructions and best practice. You might like to read https://go.hashi.co/rfc/eng-051.

One way to improve this setup is to:

split this top level instructions up into smaller, targeted instruction files each of the files has a glob pattern defined. In VS Code the files would then automatically be included in every prompt in the chat mode. In this case it seems one could split us as follows:

js.instructions.md (general js best practice)

ember.instructions.md (ember specific rules)

api.instructions.md (Restful)

Follow general prompt best practice:

short, concise bullet points

Prefer positive over negative instructions

You can find more examples and inspiration in the doc above.

Finally, we have created a shared repo for instructions within HashiCorp https://github.com/hashicorp/copilot-resources

github-actions · 2025-08-08T22:38:58Z

Build Results:
All builds succeeded! ✅

.github/instructions/generic/ember_hbs.instructions.md

.github/instructions/generic/ember_tests.instructions.md

hellobontempo

Left some comments, nice work!

hellobontempo · 2025-08-13T22:15:39Z

.github/instructions/generic/ember_tests.instructions.md

 });
 ```

+> **Note**: Avoid manual server setup and shutdown. Use `setupMirage(hooks)` instead to prevent memory leaks and reduce boilerplate code.


👏 😍 😍 😍

hellobontempo · 2025-08-13T22:16:00Z

.github/instructions/generic/ember_tests.instructions.md

+});
+```
+
+**Avoid** - unnecessary nesting for organization only:


Love! great work updating these

hellobontempo

🚀

ryancragun

Two caveats here:

I don't use VSCode and as such have no idea what the actual outcomes of my suggestions will be for those who do. This PR has motivated me to set aside some time to test copilot in nvim and see what happens.
I did not really review the ember sections as I'm by no means any sort of authority in that area of the code base.

That said, I'm 👍 on merging this with a few small tweaks to the golang and testing sections.

We might want to hold off on merging this until next week as it'll be easier to deal with the backports that touch .github, but that's entirely up to you. If you do merge it I suspect you'll have to manually backport the changes to vault-enterprise release branches for 1.16.x+ent, 1.18.x+ent, and 1.19.x+ent.

ryancragun · 2025-08-14T17:21:58Z

.github/instructions/generic/golang.instructions.md

+# Go Programming Instructions
+
+## Code Style and Formatting
+- Use `gofmt` and `goimports` to format all Go code automatically


We use gofumpt, gosimports, and golines formatting

ryancragun · 2025-08-14T17:23:18Z

.github/instructions/generic/golang.instructions.md

+## Control Structures
+- Use initialization statement in if/switch when appropriate:
+  ```go
+  if err := file.Chmod(0664); err != nil {


Suggested change

if err := file.Chmod(0664); err != nil {

if err := file.Chmod(0o664); err != nil {

ryancragun · 2025-08-14T17:24:09Z

.github/instructions/generic/golang.instructions.md

+## Interfaces and Composition
+- Design small, focused interfaces (often single-method)
+- Accept interfaces, return concrete types
+- Use empty interface `interface{}` or any sparingly


Suggested change

- Use empty interface `interface{}` or any sparingly

- Use empty interface `interface{}` or `any` sparingly

ryancragun · 2025-08-14T17:27:13Z

.github/instructions/generic/golang_tests.instructions.md

+## General Guidelines
+- Write unit tests for all public functions
+- Use table-driven tests when appropriate
+- Follow naming convention: `TestFunctionName`


We often actually underscore in Vault. e.g. Test_FunctionName

ryancragun · 2025-08-14T17:28:20Z

.github/instructions/generic/golang_tests.instructions.md

+
+## Test Structure
+- Use t.Helper() to mark helper functions
+- Use subtests for organizing related test cases with t.Run()


I would also suggest using t.Parallel(). Not only does this yield faster test run, it also encourages writing tests that do not share state or require specific ordering.

ryancragun · 2025-08-14T17:29:22Z

.github/instructions/generic/golang_tests.instructions.md

+- Use testcontainers to spin up dependencies like postgres or redis
+
+## Black box testing 
+- The test should be in feature_test package to be the first client of the feature package


Eventually we'll want to add a section here on end-to-end testing with enos and cloud first testing in Vault Cloud. That does not need to happen in this PR but I wanted to comment on it for posterity.

ryancragun · 2025-08-14T17:31:39Z

.github/instructions/generic/testing.instructions.md

+- A unit test should only fail for one reason
+- Do not share state between tests
+- Cleanup resources after the test
+- If files are needed, use a temp directory


Perhaps mention using t.TempDir() as it can create one for you that is automatically cleaned up.

use copilot resources example repo (https://github.com/hashicorp/copilot-resources/tree/main)

beagins · 2025-08-18T17:16:11Z

Addressed PR comments & cherrypicked changes to vault-enterprise repo: https://github.com/hashicorp/vault-enterprise/pull/8680

…ashicorp#8728) * add copilot instructions to repository use copilot resources example repo (https://github.com/hashicorp/copilot-resources/tree/main) * address PR comments (hashicorp#31361) Co-authored-by: Shannon Roberts (Beagin) <[email protected]>

github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jul 23, 2025

beagins force-pushed the ui/hackweek/copilot branch from 2345256 to 0f57c38 Compare July 23, 2025 23:48

vercel bot had a problem deploying to Preview – vault-ui July 23, 2025 23:48 Failure

beagins force-pushed the ui/hackweek/copilot branch from 0f57c38 to 821ac86 Compare July 23, 2025 23:59

vercel bot had a problem deploying to Preview – vault-ui July 24, 2025 00:00 Failure

beagins added this to the 1.21.0-rc1 milestone Jul 24, 2025

beagins added the pr/no-changelog label Jul 24, 2025

beagins force-pushed the ui/hackweek/copilot branch from 821ac86 to b36b1b7 Compare July 24, 2025 00:02

vercel bot had a problem deploying to Preview – vault-ui July 24, 2025 00:02 Failure

nikolasrieble reviewed Jul 25, 2025

View reviewed changes

vercel bot deployed to Preview – vault-ui July 29, 2025 22:13 View deployment

vercel bot deployed to Preview – vault-ui July 29, 2025 22:50 View deployment

vercel bot deployed to Preview – vault-ui July 29, 2025 23:22 View deployment

vercel bot deployed to Preview – vault-ui July 29, 2025 23:35 View deployment

vercel bot deployed to Preview – vault-ui July 29, 2025 23:40 View deployment

vercel bot deployed to Preview – vault-ui July 29, 2025 23:48 View deployment

vercel bot deployed to Preview – vault-ui July 29, 2025 23:50 View deployment

vercel bot deployed to Preview – vault-ui July 30, 2025 00:01 View deployment

vercel bot deployed to Preview – vault-ui July 30, 2025 00:26 View deployment

vercel bot deployed to Preview – vault-ui July 31, 2025 00:04 View deployment

vercel bot deployed to Preview – vault-ui August 8, 2025 16:00 View deployment

beagins force-pushed the ui/hackweek/copilot branch from 6bf75a9 to 5f9a7c0 Compare August 8, 2025 16:35

vercel bot deployed to Preview – vault-ui August 8, 2025 16:35 View deployment

beagins marked this pull request as ready for review August 8, 2025 22:11

beagins requested a review from a team as a code owner August 8, 2025 22:11

beagins force-pushed the ui/hackweek/copilot branch from 5f9a7c0 to fb05635 Compare August 12, 2025 15:56

vercel bot deployed to Preview – vault-ui August 12, 2025 15:56 View deployment

hellobontempo reviewed Aug 13, 2025

View reviewed changes

.github/instructions/generic/ember_hbs.instructions.md Outdated Show resolved Hide resolved

hellobontempo reviewed Aug 13, 2025

View reviewed changes

.github/instructions/generic/ember_tests.instructions.md Outdated Show resolved Hide resolved

hellobontempo reviewed Aug 13, 2025

View reviewed changes

.github/instructions/generic/ember_tests.instructions.md Outdated Show resolved Hide resolved

hellobontempo previously approved these changes Aug 13, 2025

View reviewed changes

beagins dismissed hellobontempo’s stale review via 56fcdd9 August 13, 2025 21:22

vercel bot deployed to Preview – vault-ui August 13, 2025 21:23 View deployment

beagins force-pushed the ui/hackweek/copilot branch from 56fcdd9 to 38e97b0 Compare August 13, 2025 21:25

vercel bot deployed to Preview – vault-ui August 13, 2025 21:25 View deployment

beagins requested a review from hellobontempo August 13, 2025 21:59

hellobontempo reviewed Aug 13, 2025

View reviewed changes

hellobontempo approved these changes Aug 13, 2025

View reviewed changes

beagins enabled auto-merge (squash) August 13, 2025 22:30

beagins disabled auto-merge August 13, 2025 23:40

ryancragun reviewed Aug 14, 2025

View reviewed changes

add copilot instructions to repository

acecb74

use copilot resources example repo (https://github.com/hashicorp/copilot-resources/tree/main)

beagins force-pushed the ui/hackweek/copilot branch from 38e97b0 to acecb74 Compare August 18, 2025 16:58

vercel bot deployed to Preview – vault-ui August 18, 2025 16:59 View deployment

beagins closed this Aug 18, 2025

beagins deleted the ui/hackweek/copilot branch August 25, 2025 22:53

	if err := file.Chmod(0664); err != nil {
	if err := file.Chmod(0o664); err != nil {

	- Use empty interface `interface{}` or any sparingly
	- Use empty interface `interface{}` or `any` sparingly

UI: hackweek: add copilot instructions to ui repo #31361

UI: hackweek: add copilot instructions to ui repo #31361

Uh oh!

Conversation

beagins commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

github-actions bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nikolasrieble Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hellobontempo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hellobontempo left a comment

Choose a reason for hiding this comment

Uh oh!

ryancragun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

beagins commented Aug 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

beagins commented Jul 23, 2025 •

edited

Loading

github-actions bot commented Jul 23, 2025 •

edited

Loading

vercel bot commented Jul 23, 2025 •

edited

Loading

nikolasrieble Jul 25, 2025 •

edited

Loading

github-actions bot commented Aug 8, 2025 •

edited

Loading