Skip to main content

🚀 ci-github

Generate GitHub Actions workflow files for geol.

đŸ–Ĩī¸ Usage​

geol ci-github [command] [options]

📄 Description​

The ci-github command generates GitHub Actions workflow files that can be used to automate lifecycle checks with geol.

By default, this command generates a ready-to-use GitHub Actions workflow.

This is equivalent to:

geol ci-github init

The generated workflow can be committed directly to a repository and used to monitor product end-of-life (EOL) status in CI/CD pipelines.

âš™ī¸ Global Options​

OptionDescription
-f, --forceOverwrite the output file if it already exists
-o, --outputPath to the generated workflow file
-l, --log-levelLogging level (debug, info, warn, error)

📋 Available Subcommands​

SubcommandDescription
initGenerate a GitHub Actions workflow file

📄 Generate a Workflow​

Create a ready-to-use GitHub Actions workflow:

geol ci-github init

This command generates a workflow file that can be added directly to a GitHub repository.

By default, the file is created as:

.github/workflows/geol-action.yml

📁 Custom Output File​

Generate the workflow in a custom location:

geol ci-github init --output .github/workflows/eol-check.yml
tip

Use a custom file name if your repository already contains other workflow definitions.

🔄 Overwrite an Existing File​

If the output file already exists, use the --force option to replace it.

geol ci-github init --force

Example:

geol ci-github init \
--output .github/workflows/geol-action.yml \
--force
warning

Existing files will be overwritten when using the --force option.

💡 Examples​

Generate the default workflow:

geol ci-github

Generate the workflow explicitly:

geol ci-github init

Generate a workflow in a custom file:

geol ci-github init \
--output .github/workflows/eol-check.yml

Overwrite an existing workflow:

geol ci-github init --force

✅ Common Use Cases​

Use this command to:

  • Generate a GitHub Actions workflow
  • Automate lifecycle checks
  • Monitor software end-of-life dates
  • Integrate geol into CI/CD pipelines
  • Quickly bootstrap GitHub-based lifecycle monitoring

For a complete GitHub Actions integration example, see:

  • 🚀 Use geol in GitHub Actions