Skip to content

Commit

Permalink
chore: Fix typo in code comments
Browse files Browse the repository at this point in the history
  • Loading branch information
alerque committed Dec 11, 2023
1 parent 80e24d1 commit b4ffe32
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Docker Build Status](https://img.shields.io/github/actions/workflow/status/alerque/git-warp-time/deploy.yml?branch=master&label=Docker%20Build&logo=Docker)](https://github.com/alerque/git-warp-time/pkgs/container/git-warp-time)
[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/alerque/git-warp-time?label=Tag&logo=GitHub)](https://github.com/alerque/git-warp-time/releases)

CLI utility (and Rust library) that resets the timestamps of files in a Git repository working directory to the exact timestamp of the last commit which modified each file.
A CLI utility (and Rust library) that resets the timestamps of files in a Git repository working directory to the exact timestamp of the last commit which modified each file.

For use as a Rust library, include in your `Cargo.toml` as documented on the [crates.io listing](https://crates.io/crates/git-warp-time) and use per [the API documentation](https://docs.rs/git-warp-time).

Expand Down Expand Up @@ -69,6 +69,24 @@ fn main() {
}
```

## CI Usage

This may me run in a CI workflow on almost any CI platform either as a binary or using the Docker container found in the GitHub Container Registry (`docker run ghcr.io/alerque/git-warp-time:latest`).
It is important to note that the Git repository needs to be checked out with depth.
A shallow clone will cause all timestamps to be as new as the oldest commit in the clone, i.e. newer than actual.

For GitHub Actions this looks like so:

```yaml
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Git Warp Time
uses: alerque/git-warp-time:latest
```
# The story
Whenever you `git clone` a project or `git checkout` a different branch, Git will write all the relevant files to your system at the moment you run the Git command.
Expand Down
2 changes: 1 addition & 1 deletion build-aux/ax_transform_package_name.m4
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The autotools supplied AC_ARG_PROGAM enables renaming operations, but it
# The autotools supplied AC_ARG_PROGRAM enables renaming operations, but it
# supplies them as a sed operation that can be applied to multiple binaries.
# This isn't convenient to use if we're just renaming the top level package, so
# we go ahead and *do* the transformation and save for use as a substitution.
Expand Down

0 comments on commit b4ffe32

Please sign in to comment.