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

Update jira docs #1407

Merged
merged 4 commits into from
Oct 18, 2024
Merged

Update jira docs #1407

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ade9791
Update Jira docs
iain-b Oct 11, 2024
ce1a06b
Update Jira docs
iain-b Oct 18, 2024
a365903
Merge remote-tracking branch 'origin/sc-22668-update-jira-docs' into …
iain-b Oct 18, 2024
5df90c1
Update content/backstage/plugins/jira.md
iain-b Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions content/backstage/plugins/jira.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@ gettingStarted:
'/jira/api':
target: '<JIRA_URL>'
headers:
Authorization:
$env: JIRA_TOKEN
Authorization: ${JIRA_TOKEN}
Accept: 'application/json'
Content-Type: 'application/json'
X-Atlassian-Token: 'nocheck'
Expand All @@ -75,7 +74,7 @@ gettingStarted:
language: typescript
code: |
// packages/app/src/components/catalog/EntityPage.tsx
import { EntityJiraOverviewCard, isJiraAvailable } from '@roadiehq/backstage-plugin-jira';
import { EntityJiraOverviewCard, isJiraAvailable, hasJiraQuery } from '@roadiehq/backstage-plugin-jira';

const overviewContent = (
<Grid container spacing={3} alignItems="stretch">
Expand All @@ -85,6 +84,12 @@ gettingStarted:
<EntityJiraOverviewCard />
</Grid>
</EntitySwitch.Case>
<EntitySwitch.Case if={hasJiraQuery}>
<Grid item md={6}>
{/* This card can be used as an alternative or in addition to the overview card */}
<EntityJiraQueryCard title="Our Custom Query" />
</Grid>
</EntitySwitch.Case>
</EntitySwitch>
</Grid>
);
Expand All @@ -98,6 +103,8 @@ gettingStarted:
jira/project-key: <example-jira-project-key>
jira/component: <example-component> # optional, you might skip this value to fetch data for all components
jira/token-type: Bearer # optional, used for Activity stream feed. If you are using Basic auth you can skip this.
jira/label: <example-label> # optional, refine filter based on a label or labels (CSV)
jira/all-issues-jql: # optional, used by EntityJiraQueryCard, this query supports basic templating with the above annotations if present, and information from the user profile. e.g. "assignee = {{ userEmail }} AND label = ({{ label }})"

- intro: Even though you can use Bearer token please keep in mind that Activity stream feed will only contain entries that are visible to anonymous users. In order to view restricted content you will need to authenticate via Basic authentication, as described in official documentation (https://developer.atlassian.com/server/framework/atlassian-sdk/consuming-an-activity-streams-feed/#authentication).

Expand Down
Loading