git_stamp 4.2.0

Advanced await-less information provider. From simple information such as build-branch to a screen with Flutter code with commits and change history.

Git Stamp 🏷

Advanced await-less information provider. From simple information such as build-branch to a screen with Flutter code with commits and change history. How it work?

Table of Contents

• Git Stamp 🏷
  • 🏞️ Preview
    • 1. LITE & FULL
    • 2. ICON
    • 3. Generator
  • 📑️ About
    • Goal
    • Motivation
  • 🛠️ Installation
    • 1. pubspec.yaml
    • 2. .gitignore
    • 3. README.md
  • 🏗️ Generating
    • 1. Examples
    • 2. Tip
    • 3. Custom gen-only parameters
  • 💻 Usage
    • 1. ListTile
    • 2. IconButton
    • 3. showGitStampLicensePage()
    • 4. Central GitStamp node for advanced usage:
  • 📦 Integration
    • GitHub Actions
  • 📝 License

🏞️ Preview

1. LITE & FULL

Light	Dark

2. ICON

3. Generator

📑️ About

Goal

The main goal is to help locate errors in the full process of building STAGE, TEST and PROD versions.

Motivation

The main motivation was Minecraft with information like this:

Version: v1.20.81
Build: 24130126
Branch: r/20_u8
SHA: a9081c5429038dcf3f26269f7351d89f

Git Stamp code:

import 'git_stamp/git_stamp.dart';

Text('Version: ${GitStamp.appVersion}'),
Text('Build: ${GitStamp.appBuild}'),
Text('Branch: ${GitStamp.buildBranch}'),
Text('SHA: ${GitStamp.latestCommit.hash}'),

🛠️ Installation

1. pubspec.yaml

dart pub add git_stamp

2. .gitignore

Important

Add git_stamp to .gitignore.

echo -e "\n/lib/git_stamp/" >> .gitignore.

If you add a /git_stamp folder for the repository and use the FULL version, the size of the repository will grow EXPONENTIALLY.

3. README.md

Warning

Add badge to your README.md 😄️

[![Git Stamp](https://img.shields.io/badge/i%20love%20Git%20Stamp-ffff99?style=flat)](https://github.com/arononak/git_stamp)

🏗️ Generating

1. Examples

Build type	Pure Dart	CLI Command
LITE	NO	dart run git_stamp
FULL	NO	dart run git_stamp --build-type full
ICON	NO	dart run git_stamp --build-type icon
CUSTOM	YES	dart run git_stamp --gen-only build-branch,build-date-time

2. Tip

Caution

Generating requires the use of the git command-line interface (CLI).

3. Custom gen-only parameters

commit-list

diff-list

repo-creation-date

build-branch

build-date-time

build-system-info

repo-path

observed-files-list

app-version

app-build

app-name

💻 Usage

1. ListTile

if (kDebugMode) ...[
  ListTile(
    title: const Text('Git Stamp'),
    subtitle: Text(GitStamp.latestCommit.hash),
    leading: const Icon(Icons.commit),
    onTap: () => showGitStampPage(context: context),
  ),
],

2. IconButton

if (isProd == false) ...[
  IconButton(
    onPressed: () => showGitStampPage(context: context),
    icon: const Icon(Icons.book),
  ),
],

3. showGitStampLicensePage()

Note

Use function showGitStampLicensePage instead of showLicensePage if you want the name and version to be added automatically.

4. Central GitStamp node for advanced usage:

class GitStamp {
   static List<GitStampCommit> commitList
   static GitStampCommit latestCommit

   static const Map<String, String> diffList

   static const String buildBranch
   static const String buildDateTime
   static const String buildSystemInfo
   static const String repoCreationDate
   static const String repoPath
   static const String observedFilesList

   static const String appVersion
   static const String appBuild
   static const String appName

   static const bool isLiteVersion
}

📦 Integration

GitHub Actions

.github/workflows/build_and_deploy.yml

name: build_and_deploy

on:
  push:
    branches: [main]
  pull_request_target:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: subosito/flutter-action@v2
        with:
          flutter-version: '3.22.2'
          channel: 'stable'
      - run: flutter --version
      - uses: actions/setup-java@v1
        with:
          java-version: "12.x"
      - run: flutter pub get
      - run: dart run git_stamp
      - run: flutter build web --release --web-renderer canvaskit
      - uses: actions/upload-artifact@master
        with:
          name: build
          path: build/web
  deploy:
    name: "Deploy"
    runs-on: ubuntu-latest
    needs: build
    steps:
      - uses: actions/checkout@v3
      - uses: actions/download-artifact@master
        with:
          name: build
          path: build/web
      - uses: FirebaseExtended/action-hosting-deploy@v0
        with:
          repoToken: "${{ secrets.GITHUB_TOKEN }}"
          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
          projectId: xxx
          channelId: live

Important

If you use Github Action, you only get a single commit. This is normal behavior to optimize the build process and improve performance, especially for large repositories. Try configuring github actions or generating Git Stamp files before git push.

📝 License

Note

Copyright © 2024 Aron Onak. All rights reserved.
Licensed under the MIT license.
If you have any feedback, please contact me at [e-mail]