Skip to content

dailydotdev/action-devcard

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

GitHub Action for fetching the devcard from daily.dev

GitHub GitHub Workflow Status (event) GitHub release (latest by date)

Example usage

jobs:
  devcard:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: devcard
        uses: dailydotdev/[email protected]
        with:
          user_id: ${{ secrets.USER_ID }}

Action options

Required

  • user_id: this is the unique id of the devcard, it can be found in the URL of the devcard or here.
    • e.g. https://api.daily.dev/devcards/v2/0b156485612243bfa39093.2.071e276.png where the user_id is 0b156485612243bfa39093.2.071e276
    • Can be found at https://app.daily.dev/api/id

Optional

  • type: Configure orientation for devcard
    • default: Vertical (Default)
    • wide: Horizontal
  • token: GitHub Token used to commit the devcard
  • commit_branch: The branch to commit the devcard to. Defaults to the branch of the action.
  • commit_message: The commit message to use when committing the devcard. Defaults to Update ${filename}.
    • You can use ${filename} in the message to refer to the filename of the devcard.
  • commit_filename: The filename to commit the devcard to. Defaults to devcard.png.
    • You can also use any other filename ending in .png.
  • committer_email: The committer email used in commit. Defaults to [email protected].
  • committer_name: The committer name used in commit. Defaults to github-actions[bot].
  • dryrun: If set to true, the action will run as normal, but not actually commit the devcard

Advanced usage

This will save the devcard as PNG and commit to a separate branch named devcard.

jobs:
  devcard:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: devcard
        uses: dailydotdev/[email protected]
        with:
          user_id: ${{ secrets.USER_ID }}
          commit_branch: devcard
          commit_filename: devcard.png
          commit_message: "chore: update ${filename}"

Keep up-to-date with GitHub Dependabot

Since Dependabot has native GitHub Actions support, to enable it on your GitHub repo all you need to do is add the .github/dependabot.yml file:

version: 2
updates:
  # Maintain dependencies for GitHub Actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "daily"