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

[develop] Change the build log output file extension from log to txt in prod bucket #706

Conversation

BruceKropp-Raytheon
Copy link
Collaborator

DESCRIPTION OF CHANGES:

When pipeline files are archived to s3 bucket, retrieving the file via a browser attempts to render/display files of known extensions. A browser doesn't generally understand what to do with a .log extension (e.g. build.log). For ease of use in the CI Dashboard, which is a static HTML page, the s3 archived build log needs a .txt extension (e.g. build.txt).

Type of change

  • New feature (non-breaking change which adds functionality)

TESTS CONDUCTED:

This is CI/CD support, not model or app code. The resulting build log (.txt) was viewed within a browser following manual steps.

  • hera.intel
  • orion.intel
  • cheyenne.intel
  • cheyenne.gnu
  • gaea.intel
  • jet.intel
  • wcoss2.intel
  • NOAA Cloud (indicate which platform)
  • Jenkins
  • fundamental test suite
  • comprehensive tests (specify which if a subset was used)

DEPENDENCIES:

would need a pipeline PR build stage (test stage not required) to see that the correct file extension is applied

DOCUMENTATION:

Any material that mentions the build log filename explicitly, in form of: srw_build-${PLATFORM}-${COMPILER}.log

ISSUE:

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain).
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

LABELS (optional):

A Code Manager needs to add the following labels to this PR:

  • enhancement
  • run_ci

CONTRIBUTORS (optional):

Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

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

These changes are renaming the build log file to a txt file in the Jenkinsfile and build script. Approving PR.

@MichaelLueken MichaelLueken added the run_we2e_coverage_tests Run the coverage set of SRW end-to-end tests label Mar 31, 2023
@MichaelLueken
Copy link
Collaborator

@BruceKropp-Raytheon Looking at the pipeline.log artifact, I see the following:

Branch indexing
Connecting to https://api.github.com using epic-cicd-jenkins/****** (GitHub account for Jenkins)
Loading trusted files from base branch develop at bd80d942d7b6a54f0a95d855d50388552de57eb7 rather than e7f74c775ed69de1da3ea43feadcae305e588147
Obtained .cicd/Jenkinsfile from bd80d942d7b6a54f0a95d855d50388552de57eb7
‘.cicd/Jenkinsfile’ has been modified in an untrusted revision

So, I don't think that we will see the update for the build files from log to txt in the pipeline. This was seen in @kbooker79's PR that updated the path of the S3 bucket to the new OAR account. Once this PR is merged, all subsequent testing should replace the log files with txt files for the build documentation.

@MichaelLueken
Copy link
Collaborator

Closing this PR and reopening PR #690 to see if the changes are in that PR, then merge in the previously reviewed PR. If there are issues with PR #690, then this PR will be reopened.

@BruceKropp-Raytheon BruceKropp-Raytheon deleted the feature/cicd_dashboard branch June 29, 2023 22:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run_we2e_coverage_tests Run the coverage set of SRW end-to-end tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants