Add documentation and setup Github Actions & Dependabot

[mark-dropbear]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @mark-dropbear, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the resource_id package by providing thorough documentation, automating CI/CD processes with GitHub Actions, and enabling automated dependency management with Dependabot. These changes improve the usability, maintainability, and reliability of the package.

Highlights

• Documentation: Adds comprehensive documentation for the resource_id package, including API usage and comparisons with UUIDs.
• GitHub Actions: Sets up GitHub Actions for continuous integration, ensuring code formatting, analysis, and testing on every push and pull request.
• Dependabot: Configures Dependabot for automated dependency updates, keeping the project's dependencies secure and up-to-date.
• README Update: Modifies the README to improve clarity regarding the size flexibility of ResourceId compared to UUIDs.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds documentation, a Dependabot configuration, and a GitHub Actions workflow. The changes are generally good and improve the project's automation and maintainability.

My review includes a few suggestions:

• In the Dependabot configuration, I've suggested adding a commit message prefix to align with conventional commit standards.
• For the new GitHub Actions workflow, I've proposed caching dependencies to speed up builds and enabling stricter analysis to catch potential issues earlier.
• I've also noted that the generated documentation files in doc/api/ should ideally be excluded from version control by adding them to .gitignore.

These changes will help improve the CI/CD process and maintain a clean commit history.

[gemini-code-assist]

This is a good start for Dependabot configuration. For better commit history clarity and to follow conventional commit standards, it's a good practice to add a commit-message configuration to prefix Dependabot commits. This helps in automatically generating changelogs and understanding the nature of commits at a glance. I've also removed the now-unnecessary comments.

  - package-ecosystem: "pub"
    directory: "/"
    schedule:
      interval: "daily"
    commit-message:
      prefix: "chore(deps)"
      include: "scope"

[gemini-code-assist]

Generated documentation files should typically not be checked into version control. They can be generated as part of a CI/CD pipeline and published to a documentation site (like GitHub Pages). Please consider adding the doc/api/ directory to your .gitignore file.

[gemini-code-assist]

This workflow can be improved in two ways:

1. Dependency Caching: To speed up the workflow, you should cache the pub dependencies. This will prevent dart pub get from re-downloading all packages on every run.
2. Stricter Analysis: Using --fatal-infos for the analyze step is a great way to enforce stricter code quality and catch potential issues early. This was even hinted at in a comment in the original file.

I've included a suggestion that applies both of these improvements.

      - uses: dart-lang/setup-dart@v1

      - name: Cache Pub dependencies
        uses: actions/cache@v3
        with:
          path: ~/.pub-cache
          key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }}
          restore-keys: |
            ${{ runner.os }}-pub-

      - name: Install dependencies
        run: dart pub get

      # Verify the use of 'dart format' on each commit.
      - name: Verify formatting
        run: dart format --output=none --set-exit-if-changed .

      # Fail on any analysis issues.
      - name: Analyze project source
        run: dart analyze --fatal-infos