chocolatey / chocolatey.docs.cake.recipe Goto Github PK

Checklist

• I have verified this is the correct repository for opening this issue.
• I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

Choco Theme, which is currently used on all the websites that Chocolatey.Docs.Cake.Recipe is intended to build, is changing away from using Gulp to compile its assets.

Describe The Solution. Why is it needed?

Within the build.cake file for this Recipe, we need to replace the usage of Gulp, and instead call the Choco Theme script using Yarn.

Additional Context

N/A

Related Issues

N/A

Checklist

• I have verified this is the correct repository for opening this issue.
• I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

There was a upstream change in GitHub that meant that GitReleaseManager no longer works. A fix for GitReleaseManager was released, and we need to update to that version.

Describe The Solution. Why is it needed?

To make the creation of release notes possible again.

Additional Context

N/A

Related Issues

N/A

Checklist

• I have verified this is the correct repository for opening this issue.
• I have verified no other issues exist related to my problem.
• I have verified this is not an issue for a specific package.
• I have verified this issue is not security related.
• I confirm I am using official, and not unofficial, or modified, Chocolatey products.

What You Are Seeing?

When running on GitHub Actions, the build runs fine all the way up to when it is time to commit the changed files in the output folder to the repository, ready for publishing. This fails due to "something" in the Cake.Git addin. It has been found that using an earlier version of the addin allows things to work corrently.

What is Expected?

The build should complete successfully, and the changes to the output files should be committed to the repository, ready for publishing to the live site.

How Did You Get This To Happen?

1. Run a build of say the boxstarter.org site using Chocolatey.Docs.Cake.Recipe
2. See an error similar to the following

An error occurred when executing task 'Publish-Documentation'.
Error: No error message has been provided by the native library

System Details

N/A

Installed Packages

N/A

Output Log

N/A

Additional Context

N/A

In this initial release, we should be able to include all the functionality that is currently offered by the individual build scripts that are used in:

• blog
• chocolatey.org
• chocolateyfest
• docs
• boxstarter.org

including the ability to:

• clean folders
• run Yarn
• run Gulp
• run Statiq, both build and preview
• publish documentation

Checklist

• I have verified this is the correct repository for opening this issue.
• I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

Right now, developing choco-theme is somewhat of a pain. Because choco-theme is on so many repositories, it requires each repository to be ran separately in order to see any changes. There are a series of commands that need to be ran on each repository, and doing so is time costly.

Describe The Solution. Why is it needed?

Create a sweet of commands that can be ran on choco-theme for local development:

Automatically rebuild choco-theme on changes, and place them in desired repositories.
Trigger automatic rebuilds of each repository specified when new files are placed by choco-theme.
Enable the preview of each repository at the same time on different ports.
Upgrade the version of choco-theme on each repository at once
yarn link and unlink choco-theme on each repository.

Additional Context

These workflows are mainly focused on local development, but may be adapted to work in other environments in the future.

Related Issues

All information in this issue is taken from chocolatey/choco-theme#402