Re: [edk2-devel] [PATCH v1 1/1] .github/workflows/codeql.yml: Update actions being deprecated

["Michael Kubacki" <mikuback@linux.microsoft.com>]

On 2/27/2024 1:33 AM, Michael D Kinney wrote:
>> -----Original Message-----
>> From: mikuback@linux.microsoft.com <mikuback@linux.microsoft.com>
>> Sent: Monday, February 26, 2024 8:39 PM
>> To: devel@edk2.groups.io
>> Cc: Sean Brogan <sean.brogan@microsoft.com>; Joey Vagedes
>> <joey.vagedes@gmail.com>; Kinney, Michael D
>> <michael.d.kinney@intel.com>
>> Subject: [PATCH v1 1/1] .github/workflows/codeql.yml: Update actions
>> being deprecated
>>
>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> Currently CodeQL runs have the following warnings:
>>
>>    Node.js 16 actions are deprecated. Please update the following
>>    actions to use Node.js 20: actions/setup-python@v4,
>>    actions/upload-artifact@v3, actions/cache@v3. For more information
>>    see:
>>    https://github.blog/changelog/2023-09-22-github-actions-
>> transitioning-from-node-16-to-node-20/.
>>
>> And:
>>
>>    CodeQL Action v2 will be deprecated on December 5th, 2024. Please
>>    update all occurrences of the CodeQL Action in your workflow files
>>    to v3. For more information, see:
>>    https://github.blog/changelog/2024-01-12-code-scanning-deprecation-
>> of-codeql-action-v2/
>>
>> The first is resolved by updating the actions to the latest versions
>> that were released to use Node.js 20. The second is specifically
>> referring to the codeql-action/upload-sarif action which is at v2.
>>
>> This change updates all of the actions to the latest releases to
>> prevent deprecated versions from continuing to be used.
>>
>> Cc: Sean Brogan <sean.brogan@microsoft.com>
>> Cc: Joey Vagedes <joey.vagedes@gmail.com>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>> ---
>>   .github/workflows/codeql.yml | 37 +++++++++++++-------
>>   1 file changed, 24 insertions(+), 13 deletions(-)
>>
>> diff --git a/.github/workflows/codeql.yml
>> b/.github/workflows/codeql.yml
>> index c91e9d4dbeb3..e0c5f69f6cdf 100644
>> --- a/.github/workflows/codeql.yml
>> +++ b/.github/workflows/codeql.yml
>> @@ -79,7 +79,7 @@ jobs:
>>         uses: actions/checkout@v4
>>
>>       - name: Install Python
>> -      uses: actions/setup-python@v4
>> +      uses: actions/setup-python@v5
>>         with:
>>           python-version: '3.11'
>>           cache: 'pip'
>> @@ -136,15 +136,26 @@ jobs:
>>
>> print(f'ci_setup_supported={str(ci_setup_supported).lower()}', file=fh)
>>               print(f'setup_supported={str(setup_supported).lower()}',
>> file=fh)
>>
>> +    - name: Convert Arch to Log Format
>> +      id: convert_arch_hyphen
>> +      env:
>> +        ARCH_LIST: ${{ matrix.ArchList }}
>> +      shell: python
>> +      run: |
>> +        import os
>> +
>> +        with open(os.environ['GITHUB_OUTPUT'], 'a') as fh:
>> +            print(f'arch_list={os.environ["ARCH_LIST"].replace(",", "-
>> ")}', file=fh)
> 
> I do not see this change described in the commit message.  Is it related?
> 

Yes. A breaking change 
(https://github.com/actions/upload-artifact?tab=readme-ov-file#breaking-changes) 
in the actions/upload-artifact action is:

"Due to how Artifacts are created in this new version, it is no longer 
possible to upload to the same named Artifact multiple times. You must 
either split the uploads into multiple Artifacts with different names, 
or only upload once. Otherwise you will encounter an error."

We depended on that behavior previously to append multiple logs (e.g. 
setup log, update log, build log) to the same named artifact (named per 
package). These were appended after each operation so they are readily 
available if the operation failed and no further actions are run.

Now the artifacts must be unique in name. The hyphenation comes in 
because edk2 further builds some packages with both architectures in 
single build vs separate builds (e.g. IA32 and X64 vs IA32,X64). To 
uniquely name artifacts resulting from those builds, the architecture is 
also placed in the artifact name. For builds with multiple architectures 
the artifact name captures each architecture separated by a hyphen.

The final result is shown here: 
https://github.com/tianocore/edk2/actions/runs/8059750360

I will update the commit message to mention a behavior change in the 
underlying action caused a change in artifact naming convention.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116048): https://edk2.groups.io/g/devel/message/116048
Mute This Topic: https://groups.io/mt/104597854/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-