Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Allow pulling translations from a commit hash #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Allow pulling translations from a commit hash #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ regularly and useful to understand ``atlas`` at a glance.
slug of the GitHub repository to pull from. Defaults 'openedx/openedx-translations'.

`-n` or `--revision`:
Git revision to pull from. Currently only branches and tags are supported. Defaults to 'main'.
Git revision to pull from. Support branches, tags, and commits hashes. Defaults to 'main'.

This option name used to be `-b` or `--branch`. The deprecated name will be removed in a future release.

Expand Down
27 changes: 15 additions & 12 deletions atlas
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Options:
slug of the GitHub repository to pull from. Defaults 'openedx/openedx-translations'.

\`-n\` or \`--revision\`:
Git revision to pull from. Currently only branches and tags are supported. Defaults to 'main'.
Git revision to pull from. Support branches, tags, and commits hashes. Defaults to 'main'.

This option name used to be \`-b\` or \`--branch\`. The deprecated name will be removed in a future release.

Expand Down Expand Up @@ -200,7 +200,7 @@ Options:
slug of the GitHub repository to pull from. Defaults 'openedx/openedx-translations'.

`-n` or `--revision`:
Git revision to pull from. Currently only branches and tags are supported. Defaults to 'main'.
Git revision to pull from. Support branches, tags, and commits hashes. Defaults to 'main'.

This option name used to be `-b` or `--branch`. The deprecated name will be removed in a future release.

Expand Down Expand Up @@ -507,18 +507,21 @@ pull_translations() {
quiet="--quiet"
fi

if [ "$pull_revision" ];
then
pull_revision_argument="--branch=${pull_revision}"
else
pull_revision_argument=""
fi

# Creating a shallow clone of the repo without without pulling the files yet
# shellcheck disable=SC2086
git clone $quiet $pull_revision_argument --filter=blob:none --no-checkout --depth=1 \
"https://github.com/${pull_repository}.git" translations_TEMP || exit
git init $quiet translations_TEMP || exit
cd translations_TEMP || exit
git remote add origin "https://github.com/${pull_repository}.git" || exit
# Requires server to allow pulling commits by direct commit hash reference,
# controlled by uploadpack.allowAnySHA1InWant and related configs. (GitHub
# does allow this, though.)
#
# The `remote.<name>.promisor` config override is needed for git 2.25 and possibly
# later versions (but not in 2.30 and later). In some earlier versions it might
# instead need to be written as `extensions.partialClone=origin` -- 2.25.1 mentions
# this in its output if a promisor is not set, but doesn't actually *use* that config.
Comment on lines +519 to +522
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some info on this inconsistency: https://lore.kernel.org/git/[email protected]/T/

git -c remote.origin.promisor=true fetch \
$quiet --filter=blob:none --depth=1 origin "${pull_revision:-main}" || exit

# finished "Creating a temporary Git repository to pull translations into <temp dir>..." step
if [ -z "$SILENT" ];
Expand Down Expand Up @@ -564,7 +567,7 @@ pull_translations() {
fi

# Retrieve translation files from the repo
git checkout HEAD
git checkout $quiet FETCH_HEAD

# Remove .git directory
rm -rf .git
Expand Down
12 changes: 8 additions & 4 deletions spec/pull_spec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,16 @@ Describe 'Pull with directory param'
It 'calls everything properly with multiple directories'
When call pull_translations
The output should equal 'Creating a temporary Git repository to pull translations into "./translations_TEMP"...
git clone --branch=pull_revision --filter=blob:none --no-checkout --depth=1 https://github.com/pull_repository.git translations_TEMP
git init translations_TEMP
cd translations_TEMP
git remote add origin https://github.com/pull_repository.git
git -c remote.origin.promisor=true fetch --filter=blob:none --depth=1 origin pull_revision
Done.
Setting git sparse-checkout rules...
git sparse-checkout set --no-cone !* pull_directory/** pull_dir2/** missing_pull_dir/**
Done.
Pulling translation files from the repository...
git checkout HEAD
git checkout FETCH_HEAD
rm -rf .git
cd ..
mkdir -p local_dir
Expand Down Expand Up @@ -157,10 +159,12 @@ Describe 'Pull filters'

It 'sets correct sparse-checkout rules'
When call pull_translations
The output should equal 'git clone --branch=pull_revision --filter=blob:none --no-checkout --depth=1 https://github.com/pull_repository.git translations_TEMP
The output should equal 'git init translations_TEMP
cd translations_TEMP
git remote add origin https://github.com/pull_repository.git
git -c remote.origin.promisor=true fetch --filter=blob:none --depth=1 origin pull_revision
git sparse-checkout set --no-cone !* pull_directory/**/ar/** pull_directory/**/ar.* pull_directory/**/es_419/** pull_directory/**/es_419.* pull_directory/**/fr_CA/** pull_directory/**/fr_CA.*
git checkout HEAD
git checkout FETCH_HEAD
cd ..'
End
End
Loading