cake-contrib / cake.npm.module Goto Github PK

Cake 2.0.0 has been released 🎉

The Discussion platform for Cake-Contrib has been moved from Gitter to GitHub Discussion (see cake-build/website#1470).
Please check this repo for references to Gitte and replace them accordingly.

Search suggests that references could be in

• docs/input/_Bottom.cshtml

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update github/codeql-action digest to 4355270

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

currently about looks like this:

The descripttion should be:

Cake.Npm.Module is a Module for Cake, which extends it with a new IPackageInstaller for installing tools using the Node.js package manager (npm)

The website-link should be:

https://cake-contrib.github.io/Cake.Npm.Module/

This project is missing the CodeQL workflow

• Dependencies should be kept up-to-date by adding a .github/dependabot.yml
• Do not build on "Pull request" events should be set in AppVeyor settings
• GitHub-Actions should be added to have a build on PRs

These changes conform to https://cake-contrib.github.io/Cake.Recipe/docs/upgrading/1.x-to-2.x, sections Add dependabot config file and Add GitHub Actions.

To facilitate easy deployments of new versions we should switch the build to cake.recipe

• There is a link to gitter, which should be replaced with discussions in cake-build/cake
• There are some references to --bootstrap which is no longer needed in Cake 1.0.0
• Examples page has a broken reference to parameters.md

Documentation still advises to create a tools/Modules/packages.config instead of adding a #module-references in the cake file.

The current build lists 47 issues of which are 15 warnings.

The warnings (at least) should be removed.

The current NuGet.org page looks a bit "empty" without one.

and fix the occurring issues.

Remove PackageIcon and PackageIconUrl - both are now set automatically
probably fix some warnings.

We performed an automated audit of your Cake addin and found that it does not follow all the best practices.

We encourage you to make the following modifications:

• You are currently referencing Cake.Core 0.28.1. Please upgrade to 0.33.0
• The nuget package for your addin should use the cake-contrib icon. Specifically, your addin's .csproj should have a line like this: <PackageIconUrl>https://cdn.jsdelivr.net/gh/cake-contrib/graphics/png/cake-contrib-medium.png</PackageIconUrl>.

Apologies if this is already being worked on, or if there are existing open issues, this issue was created based on what is currently published for this package on NuGet.

This issue was created by a tool: Cake.AddinDiscoverer version 3.12.1

Current status

When installing some tool locally, it is installed in the WorkingDirectory, not in the tools folder.
While this works for most cases the tool is not available as a tool in cake. I.e. it will not be found by the IToolLocator.

Example:

#module nuget://?package=Cake.Npm.Module
#tool npm://?package=yo

Task("Default")
.Does(() => {
   var yo = Context.Tools.Resolve("yo.cmd");
   if(yo == null) {
      yo = Context.Tools.Resolve("yo");
   }
   if(yo == null) {
      Error("Something is very wrong.");
      throw new Exception("yo not found!");
   }
   Information("yo installed at: " + yo.FullPath);
   IEnumerable<string> version;
   StartProcess(
      yo,
      new ProcessSettings {
            Arguments = "--version",
            RedirectStandardOutput = true
      },
      out version);
   Information("yo version: " + version.First());
});

RunTarget("Default");

this will not find yo as a tool, unless yo was installed globally on the system (either by installing it manually or by setting #tool npm://?package=yo&global)
Additionally, the node_modules folder will "clutter" the WorkingDirectory.

Proposal

I propose adding a new flag caketool (to not break current API) which will install the tool unter the tools folder. This will keep the WorkingDirectory "clean" and make all tools available for usage as tools in Cake. I.e. after implementing that, setting #tool npm://?package=yo&caketool will make above example work.

Using the module under windows results in the following error:

❯ .\build.ps1 --verbosity=diagnostic
Preparing to run build script...
Running build script...
Registering module Cake.Npm.Module.NpmModule...
Analyzing build script...
Analyzing D:/_dev/Cake.Npm.Module.Tests2/build.cake...
Processing build script...
Installing addins...
Installing package asciidoctor with npm...
Executing: "npm" install --verbose asciidoctor
Error: System.ComponentModel.Win32Exception (0x80004005): The system cannot find the file specified
   at System.Diagnostics.Process.StartWithCreateProcess(ProcessStartInfo startInfo)
   at System.Diagnostics.Process.Start(ProcessStartInfo startInfo)
   at Cake.Core.IO.ProcessRunner.Start(FilePath filePath, ProcessSettings settings)
   at Cake.Npm.Module.NpmPackageInstaller.Install(PackageReference package, PackageType type, DirectoryPath path)
   at Cake.Core.Scripting.ScriptProcessor.InstallAddins(ScriptAnalyzerResult analyzerResult, DirectoryPath installPath)
   at Cake.Core.Scripting.ScriptRunner.Run(IScriptHost host, FilePath scriptPath, IDictionary`2 arguments)
   at Cake.Commands.BuildCommand.Execute(CakeOptions options)
   at Cake.CakeApplication.Run(CakeOptions options)
   at Cake.Program.Main()

To be aligned with new guidance/best practices on developing Modules for Cake:

§2.6 Avoid targeting additional frameworks such as net461 or net5.0.

Why? Due to current limitations on how modules are loaded, Cake attempts to load all assemblies included in the NuGet package of the module (of all targets) which causes warnings to be displayed and the impression that the module was not loaded and/or is not working.
Once those limitations are fixed, we'll update this recommendation to align with the recommendations for Cake Addins.

Cake 4.0.0 has been released 🎉

The NuGet Gallery will soon include a "Cake" tab with instructions on how to use NuGet packages in Cake build scripts. I'd like to suggest that you include the tag cake-module in the NuGet package of this module, so that the NuGet Gallery can display the correct instructions to install this module.

The UI will look similar to this:

Documentation on best practices on tags for Cake modules: https://cakebuild.net/docs/extending/modules/best-practices#tags

README.md points to https://cake-contrib.github.io/Cake.Npm.Module/ as documentation.
However, that URL is "empty".

• The current documentation should be deployed to gh-pages.
• Ideally deployment of docfx to the gh-pages-branch should be automated.

Currently, the default Gitter/Twitter messages are being used when pushing a new release of this module, which includes mention of it being and Addin. We should update it to make it clear that this is a module.

virtual environment is not pinned.

Also, there was a warning before the error started:

1 issue was detected with this workflow: git checkout HEAD^2 is no longer necessary. Please remove this step as Code Scanning recommends analyzing the merge commit for best results.

Reference https://www.nuget.org/packages/CakeContrib.Guidelines/ and follow it's guides.

Also check https://github.com/cake-contrib/Home/blob/master/Guidelines.md for additional requirements. (I.e. multi-targeting to netstandard2.0 and net461)

To take advantage of updating of issues when milestone is closed, and also so apply a SHA to all uploaded artifacts in the GitHub Release.