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.

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

fix: move build source info to a separate location #1783

Merged
merged 1 commit into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 0 additions & 11 deletions alire.toml
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,3 @@ command = ["pwsh", "scripts/version-patcher.ps1"]
[actions.'case(os)'.'...']
type = "pre-build"
command = ["scripts/version-patcher.sh"]

# Afterwards we leave an extra note, so people manually building don't use a
# misleading commit.
[[actions]]
[actions.'case(os)'.windows]
type = "post-build"
command = ["pwsh", "scripts/version-patcher.ps1", "_or_later"]

[actions.'case(os)'.'...']
type = "post-build"
command = ["scripts/version-patcher.sh", "_or_later"]
2 changes: 0 additions & 2 deletions dev/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,3 @@ scripts/version-patcher.sh

echo "Building with ALIRE_OS=$ALIRE_OS and $(gnat --version | head -1)"
gprbuild "-j$ALIRE_BUILD_JOBS" -r -p -P "$(dirname $0)/../alr_env.gpr" "$@"

scripts/version-patcher.sh _or_later
3 changes: 2 additions & 1 deletion scripts/version-patcher.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ if (Test-Path $bin) {
& $bin @args

Write-Output "Resulting version file:"
Get-Content src/alire/alire-version.ads | Select-String "Current_Str"
Get-Content src/alire/alire-meta.ads | Select-String "Commit"
Get-Content src/alire/alire-meta.ads | Select-String "Changes"
55 changes: 0 additions & 55 deletions scripts/version-patcher.py

This file was deleted.

5 changes: 3 additions & 2 deletions scripts/version-patcher.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,6 @@ fi

$bin "$@"

echo "Resulting version file:"
cat src/alire/alire-version.ads | grep "Current_Str : constant String"
echo "Resulting build metadata info:"
cat src/alire/alire-meta.ads | grep "Commit"
cat src/alire/alire-meta.ads | grep "Changes"
14 changes: 14 additions & 0 deletions src/alire/alire-meta.ads
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package Alire.Meta with Preelaborate is

-- Root package for information about Alire itself. Alire.Version could be
-- moved here if at some point there is a reason good enough to expend the
-- energy.

package Working_Tree is

Commit : constant String := "unknown";
Changes : constant String := "unknown";

end Working_Tree;

end Alire.Meta;
3 changes: 3 additions & 0 deletions src/alr/alr-commands-version.adb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ with Alire.Settings.Edit;
with Alire.Directories;
with Alire.Index;
with Alire.Index_On_Disk.Loading;
with Alire.Meta;
with Alire.Milestones;
with Alire.Origins.Deployers.System;
with Alire.Paths.Vault;
Expand Down Expand Up @@ -91,6 +92,8 @@ package body Alr.Commands.Version is
Add ("APPLICATION", "");
Add ("alr version:", Alire.Version.Current.Image);
Add ("libalire version:", Alire.Version.Current.Image);
Add ("source commit:", Alire.Meta.Working_Tree.Commit);
Add ("source changes:", Alire.Meta.Working_Tree.Changes);
Add ("compilation date:",
GNAT.Source_Info.Compilation_ISO_Date & " "
& GNAT.Source_Info.Compilation_Time);
Expand Down
91 changes: 59 additions & 32 deletions support/version_patcher/src/version_patcher.adb
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
with Ada.Command_Line; use Ada.Command_Line;
with Ada.Directories;
with Ada.Environment_Variables; use Ada.Environment_Variables;
with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
Expand All @@ -13,43 +12,63 @@ with GNAT.OS_Lib;

procedure Version_Patcher is

---------------------
-- Replace_Version --
---------------------
------------------
-- Replace_Info --
------------------

procedure Replace_Version (Filename : String; Build_Info : String) is
procedure Replace_Info
(Filename : String;
-- File in which to look for patterns
Trigger : String;
-- Substring that will trigger replacement in a line. The only text in
-- quotes will be replaced.
Replacement : String)
-- Replacement
is
F : Ada.Text_IO.File_Type;
O : Ada.Text_IO.File_Type;
use Ada.Text_IO;

Target : constant String := "Current_Str : constant String :=";
Hit : Boolean := False;
begin
Open (F, In_File, Filename);
Create (O, Out_File, Filename & ".new");
while not End_Of_File (F) loop
declare
Line : constant String := Get_Line (F);
begin
if (for some I in Line'Range =>
I + Target'Length - 1 <= Line'Last and then
Line (I .. I + Target'Length - 1) = Target)
if not Hit and then
(for some I in Line'Range =>
I + Trigger'Length - 1 <= Line'Last and then
Line (I .. I + Trigger'Length - 1) = Trigger)
then
declare
Quotes_Seen : Boolean := False;
Ini : Integer := Line'First - 1;
Fin : Integer := Line'First - 1;
begin
for Char of Line loop
if Char = '"' and then not Quotes_Seen then
Quotes_Seen := True;
Put (O, Char);
elsif (Char = '"' and then Quotes_Seen)
or else Char = '+'
then
Put_Line (O, "+" & Build_Info & '"' & ";");
exit;
else
Put (O, Char);
for I in Line'Range loop
if Line (I) = '"' then
if Ini < Line'First then
Ini := I;
elsif Fin < Line'First then
Fin := I;
else
raise Constraint_Error
with "Too many quotes in line: " & Line;
end if;
end if;
end loop;

if Ini < Line'First or else Fin < Line'First then
raise Constraint_Error
with "No quoted string in line: " & Line;
end if;

Put_Line
(O,
Line (Line'First .. Ini)
& Replacement
& Line (Fin .. Line'Last));
Hit := True;
end;
else
Put_Line (O, Line);
Expand All @@ -60,10 +79,15 @@ procedure Version_Patcher is
Close (F);
Close (O);

if not Hit then
raise Constraint_Error
with "Trigger not found in file: " & Trigger;
end if;

Ada.Directories.Delete_File (Filename);
Ada.Directories.Rename (Filename & ".new", Filename);

end Replace_Version;
end Replace_Info;

-----------------
-- Git_Command --
Expand Down Expand Up @@ -94,14 +118,12 @@ begin

declare
Dirty : constant String
:= (if Argument_Count > 0 then
Argument (1)
elsif Git_Command ("diff-index --quiet HEAD --").Code /= 0 then
"_dirty"
:= (if Git_Command ("diff-index --quiet HEAD --").Code /= 0 then
"dirty"
else
"");
"clean");
Commit_Result : constant Result :=
Git_Command ("rev-parse --short HEAD");
Git_Command ("rev-parse HEAD");
Commit : constant String := To_String (Commit_Result.Output);
begin
if Commit_Result.Code /= 0 then
Expand All @@ -110,8 +132,13 @@ begin
& Commit_Result.Code'Image;
end if;
Ada.Text_IO.Put_Line
("Updating version in src/alire/alire-version.ads to commit "
& Commit & Dirty & "...");
Replace_Version ("src/alire/alire-version.ads", Commit & Dirty);
("Updating src/alire/alire-meta.ads to commit [" & Commit
& "] with status [" & Dirty & "]");
Replace_Info ("src/alire/alire-meta.ads",
"Commit",
Commit);
Replace_Info ("src/alire/alire-meta.ads",
"Changes",
Dirty);
end;
end Version_Patcher;
Loading