Skip to content

feat: add Code References to project integrations page#6974

Open
talissoncosta wants to merge 2 commits intomainfrom
feat/code-references-integration-6915
Open

feat: add Code References to project integrations page#6974
talissoncosta wants to merge 2 commits intomainfrom
feat/code-references-integration-6915

Conversation

@talissoncosta
Copy link
Contributor

@talissoncosta talissoncosta commented Mar 17, 2026

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Closes #6915

Adds "Code References" as an external integration on the project Integrations page, following the same pattern as Backstage (external link to docs, no in-app configuration).

  • common/stores/default-flags.ts — new code-references entry with external: true
  • web/static/images/integrations/code-references.svg — code brackets icon

Deployment note

The integration list is controlled by the integration_data remote config flag in Flagsmith. The default-flags.ts change covers self-hosted instances, but for SaaS environments the flag value must also be updated:

  • Staging — already added
  • Production — needs code-references entry added to the integration_data remote config value before merging

Screenshots

image

How did you test this code?

  1. Navigate to a project's Integrations page
  2. Verify "Code References" card appears with the correct icon, description, and "Add Integration" button
  3. Click "Add Integration" — verify it opens https://docs.flagsmith.com/managing-flags/code-references in a new tab
  4. Verify no regressions on other integration cards

@vercel
Copy link

vercel bot commented Mar 17, 2026

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

Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ready Ready Preview, Comment Mar 17, 2026 10:19pm
flagsmith-frontend-staging Ready Ready Preview, Comment Mar 17, 2026 10:19pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
docs Ignored Ignored Preview Mar 17, 2026 10:19pm

Request Review

Add Code References as an external integration entry on the Integrations
page, linking to the documentation. This increases visibility of the
feature which was previously only discoverable via docs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@talissoncosta talissoncosta force-pushed the feat/code-references-integration-6915 branch from 46da101 to 6bf8c82 Compare March 17, 2026 14:59
@github-actions github-actions bot added feature New feature or request and removed feature New feature or request labels Mar 17, 2026
@talissoncosta talissoncosta marked this pull request as ready for review March 17, 2026 15:35
@talissoncosta talissoncosta requested a review from a team as a code owner March 17, 2026 15:35
@talissoncosta talissoncosta requested review from Zaimwa9 and removed request for a team March 17, 2026 15:35
@claude
Copy link

claude bot commented Mar 17, 2026

⚠️ Code review skipped — your organization's overage spend limit has been reached.

Code review is billed via overage credits. To resume reviews, an organization admin can raise the monthly limit in Settings → Usage.

Once credits are available, reopen this pull request to trigger a review.

@github-actions github-actions bot added feature New feature or request and removed feature New feature or request labels Mar 17, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2026

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-api-test:pr-6974 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-e2e:pr-6974 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-api:pr-6974 Finished ✅ Results
ghcr.io/flagsmith/flagsmith:pr-6974 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-private-cloud:pr-6974 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-frontend:pr-6974 Finished ✅ Results

@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2026

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  10 passed

Details

stats  10 tests across 7 suites
duration  11.3 seconds
commit  6bf8c82
info  🔄 Run: #15325 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  10 passed

Details

stats  10 tests across 7 suites
duration  28 seconds
commit  6bf8c82
info  🔄 Run: #15325 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  16 passed

Details

stats  16 tests across 13 suites
duration  42.6 seconds
commit  6bf8c82
info  🔄 Run: #15325 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  1 minute, 10 seconds
commit  6bf8c82
info  🔄 Run: #15325 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  10 passed

Details

stats  10 tests across 7 suites
duration  46.1 seconds
commit  1ec9bae
info  🔄 Run: #15327 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  10 passed

Details

stats  10 tests across 7 suites
duration  28.4 seconds
commit  1ec9bae
info  🔄 Run: #15327 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  56 seconds
commit  1ec9bae
info  🔄 Run: #15327 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  1 minute, 1 second
commit  1ec9bae
info  🔄 Run: #15327 (attempt 1)

@talissoncosta talissoncosta requested a review from emyller March 17, 2026 22:14
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Contributor

@emyller emyller left a comment

Choose a reason for hiding this comment

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

Cool icon! Please adjust it catering for both light and dark themes. e.g. This is how our current GitHub icon looks:

Image

},
'code-references': {
'description':
'Integrate with Code References to track feature flag usage in your codebase, and unlock new functionality in Flagsmith',
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
'Integrate with Code References to track feature flag usage in your codebase, and unlock new functionality in Flagsmith',
'Integrate with Code References to track feature flag usage in your codebase, and unlock new functionality in Flagsmith.',

Missing period.

@kyle-ssg
Copy link
Member

kyle-ssg commented Mar 18, 2026

It doesn't feel like this reduces any friction in getting started with code references, I say this for 2 reasons:

1 - We don’t surface this where the feature actually lives. That’s a problem—users currently have to scroll through the integrations list to discover it. For features that require an integration but aren’t yet enabled, we should show an “Add integration” prompt directly in the feature’s location.

image

2 - A key prerequisite for code references is linking GitHub, so that needs to be the first step in the user journey.

Right now, a new user’s flow looks like:

  • Look through a list of integrations and find the code references integration
  • Go to docs
  • Find out that it requires GitHub and go back to the app
  • Install the GitHub integration
  • Go back to the docs and go through the add workflow steps
  • Install Code References on GitHub

@emyller
Copy link
Contributor

emyller commented Mar 18, 2026

2 - A key prerequisite for code references is linking GitHub, so that needs to be the first step in the user journey.

Except for this point, all of @kyle-ssg thoughts resonate with mine. Code References was built to be provider-agnostic, and does not depend on the GitHub integration.

Note

Our hackathon project Cleanup combines Code References to the GitHub integration by creating a prompt containing code references and filing a GitHub issue.

In order to set up Code References, as described in the documentation, the only user action necessary as of now is to set up a GHA workflow in each repository. In the future, I'd love to improve the UX by allowing to install Code References organisation wide, instead of per-repository, via button clicks or IaC instead of GHA scripting.

While in the present, the question remains: where in our UI can we encourage users to go through the necessary GHA setup and try Code References, and how can it be both friendly and effective?

@kyle-ssg
Copy link
Member

kyle-ssg commented Mar 18, 2026

Ah I didn't realise that, my mistake. Ok I think as for now both of the following points are achievable and provide a less tedious flow to get started

  • We should show the add integration UI within the usage tab if thery which is the place people would be looking to see this data.
  • I think we can reduce the need to go to docs by adding the yaml code snippet + copy button for the action with a view docs link. This could be in our standard expandable code-snippet UI, another advantage of this is that we could fill in some of the parts if we know a repository via a GH integration.

@emyller
Copy link
Contributor

emyller commented Mar 18, 2026

@kyle-ssg I like both ideas. Now for the scope of this PR:

  1. Should we keep this PR and add "Code References" to the Integrations tab? Personally I think it doesn't hurt. I'd be interested to find how many people engage via this path, or via the Feature UI.
  2. Unless we decide to repurpose Add Code References to the projects Integrations page #6915, let's write a new issue that describes the ideal UX. I can look into that, and will loop @asaphko in too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature or request front-end Issue related to the React Front End Dashboard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Code References to the projects Integrations page

3 participants