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

Release Automation #264

Open
wants to merge 35 commits into
base: main
Choose a base branch
from
Open

Release Automation #264

wants to merge 35 commits into from

Conversation

rvyuha
Copy link
Collaborator

@rvyuha rvyuha commented Oct 24, 2023

Contains user guides as well as the latest github actions and code for automation.
User guides and code changes are found within the R-package directory and the new action files are found within github/workflows directory.

@rvyuha rvyuha requested a review from yulric October 24, 2023 14:11
Copy link
Collaborator

@yulric yulric left a comment

Choose a reason for hiding this comment

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

  1. Lets format the file using styler
  2. Rename R-Package to release-automation
  3. Create a proper user guide which goes the steps to create a release branch and merging a release

.github/workflows/update-documentation.yml Outdated Show resolved Hide resolved
.github/workflows/update-documentation.yml Outdated Show resolved Hide resolved
.github/workflows/upload-dictionaries.yml Outdated Show resolved Hide resolved
.github/workflows/upload-dictionaries.yml Outdated Show resolved Hide resolved
.github/workflows/upload-dictionaries.yml Outdated Show resolved Hide resolved
dictionary)

# Download previous release dictionary
past_dictionary_path <- download_dictionary(past_dictionary_path, OSF_TOKEN, OSF_REPO_LINK, odm_dictionary$tmp_dictionary_directory_past_release, origin_directory = "Current Release")
Copy link
Collaborator

Choose a reason for hiding this comment

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

This and the next lines which parses the dictionary should be pulled into a function that downloads and parses the currently released dictionary from osf. Would also be used in the create_release_files function.

#'
#' @param OSF_TOKEN The OSF token used to authenticate the user.
#' @param OSF_LINK The OSF link to the main repo.
archive_previous_release <- function(OSF_TOKEN, OSF_LINK, past_dictionary_version){
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should be split into functions. Once which creates the archive and one which uploads the new release.

R-package/R/osf-interactions.R Outdated Show resolved Hide resolved
#' @param files_to_extract A list of files to extract.
#' @param dictionary The dictionary file.
#'
stage_osf_files <- function(files_to_extract,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Isn't this function essentially the same as the create_files function.

R-package/log Outdated Show resolved Hide resolved
@yulric yulric changed the title [Feature] Bringing in changes from test repo Release Automation Nov 20, 2023
* Files
    * R-package/R/odm-dictionary-file.R: Moved the log file path to the
      new logging module.
    * R-package/R/logging.R: The new logging module.
    * R-package/R/create-release-files.R:
        * Use the new setup_logging function.
        * Display the log file path when in the warning message for
          build errors.
    * R-package/R/osf-interactions.R
        * Use the new setup_logging function
The get_dictionary function used to assume that there would be multiple
dictionaries downloaded from OSF which is unnecessary. The
dictionary_path is now the full path to the downloaded dictionary rather
than a folder that could contain multiple dictionaries.

The download_dictionary function now returns the full path to the
dictionary rather than the folder to where it's downloaded.
…e variable template_variables$version. Refactored code to use this.
…sheets. It now uses a column from a new sets sheet module.
…sheet module. Added new module called parts-sheet to contain columns for the parts sheet
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants