Backstage Should I Deploy Today? Plugin

Should I Deploy Today is a small Backstage plugin that answers a simple question for your team. It shows a card in your portal that says if today is a smart day to ship. The message and the background color change by date. You can keep it on UTC or choose a time zone that fits your org. It also comes with a full page view if you want it somewhere other than the home.

The plugin pulls a short status for the day. Think of it as a friendly guardrail. It helps curb risky end of week releases. It gives a quick signal during standups. It sets a shared rhythm for teams that follow change windows. There is no ceremony. You drop it in your app and the signal is there whenever people check Backstage.

Use it when you want a clear yes or no on deploy timing in one glance. Use it to nudge healthier release habits without writing policy. Use it to bring a bit of levity to the portal while still being useful.

Installation Instructions

These instructions apply to self-hosted Backstage only.

Install the package

Copy

# From your Backstage root directory
yarn add --cwd packages/app backstage-plugin-should-i-deploy

Add the page route

Edit packages/app/src/App.tsx

Copy

+ import { ShouldIDeployPage } from 'backstage-plugin-should-i-deploy';

  export const App = () => (
    <AppRouter>
      <AlertDisplay />
      <OAuthRequestDialog />
      <FlatRoutes>
+       <Route path="/should-i-deploy" element={<ShouldIDeployPage />} />
        {/* other routes */}
      </FlatRoutes>
    </AppRouter>
  );

You can visit the page at the path /should-i-deploy.

Add the home page card

Edit packages/app/src/components/home/HomePage.tsx

Import the card and render it inside your grid.

Copy

+ import { ShouldIDeployCard } from 'backstage-plugin-should-i-deploy';

  export const HomePage = () => (
    <Page themeId="other">
      <Header title="Home" />
      <Content>
        <Grid container direction="row" spacing={3}>
          <Grid item xs={12} md={3}>
            <Grid container direction="column" spacing={3}>
+             <Grid item>
+               <ShouldIDeployCard />
+             </Grid>
              {/* other home widgets */}
            </Grid>
          </Grid>
          {/* other columns */}
        </Grid>
      </Content>
    </Page>
  );

Optional title and time zone

You can set a title and a time zone. If you omit the title it will not render. If you omit the time zone the API uses UTC.

Copy

<ShouldIDeployCard title="Should I deploy today" timeZone="America/Sao_Paulo" />

Changelog

The Should I Deploy Today? plugin has not seen any significant changes since a year ago.

Set up Backstage in minutes with Roadie

Focus on using Backstage, rather than building and maintaining it.

Get a demo