Downloads:

12,786

Downloads of v 2020.3.6.0:

26

Last Update:

08 Mar 2020

Package Maintainer(s):

Software Author(s):

  • Eric Woodruff

Tags:

SHFB documentation sandcastle help XML comments file builder admin

Sandcastle Help File Builder and Tools (Install)

Downloads:

12,786

Downloads of v 2020.3.6.0:

26

Maintainer(s):

Software Author(s):

  • Eric Woodruff

Sandcastle Help File Builder and Tools (Install)

Some Checks Have Failed or Are Not Yet Complete

1 Test Passing and 1 Failing Test


Validation Testing Passed


Verification Testing Failed

Details

This package was rejected on 22 Nov 2020. The reviewer chocolatey-ops has listed the following reason(s):

coldacid (maintainer) on 08 Mar 2020 15:16:04 +00:00:

User 'coldacid' (maintainer) submitted package.

coldacid (maintainer) on 08 Mar 2020 15:18:01 +00:00:

User 'coldacid' (maintainer) submitted package.

chocolatey-ops (reviewer) on 08 Mar 2020 15:49:47 +00:00:

sandcastle has passed automated validation. It may have or may still fail other checks like testing (verification).
NOTE: No required changes that the validator checks have been flagged! It is appreciated if you fix other items, but only Requirements will hold up a package version from approval. A human review could still turn up issues a computer may not easily find.

Guidelines

Guidelines are strong suggestions that improve the quality of a package version. These are considered something to fix for next time to increase the quality of the package. Over time Guidelines can become Requirements. A package version can be approved without addressing Guideline comments but will reduce the quality of the package.

  • ProjectUrl and ProjectSourceUrl are typically different, but not always. Please ensure that projectSourceUrl is pointing to software source code or remove the field from the nuspec. More...

chocolatey-ops (reviewer) on 08 Mar 2020 16:23:00 +00:00:

sandcastle has failed automated testing.
This is not the only check that is performed so check the package page to ensure a 'Ready' status.
Please visit https://gist.github.com/c1c72f9f3b54ebd3bbaca1752c4455c2 for details.
The package status will be changed and will be waiting on your next actions.

  • NEW! We have a test environment for you to replicate the testing we do. This can be used at any time to test packages! See https://github.com/chocolatey/chocolatey-test-environment
  • Please log in and leave a review comment if you have questions and/or comments.
  • If you see the verifier needs to rerun testing against the package without resubmitting (a issue in the test results), you can do that on the package page in the review section.
  • If the verifier is incompatible with the package, please log in and leave a review comment if the package needs to bypass testing (e.g. package installs specific drivers).
  • Automated testing can also fail when a package is not completely silent or has pop ups (AutoHotKey can assist - a great example is the VeraCrypt package).
  • A package that cannot be made completely unattended should have the notSilent tag. Note that this must be approved by moderators.

chocolatey-ops (reviewer) on 28 Mar 2020 16:26:21 +00:00:

We've found sandcastle v2020.3.6.0 in a submitted status and waiting for your next actions. It has had no updates for 20 or more days since a reviewer has asked for corrections. Please note that if there is no response or fix of the package within 15 days of this message, this package version will automatically be closed (rejected) due to being stale.

Take action:

  • Log in to the site and respond to the review comments.
  • Resubmit fixes for this version.
  • If the package version is failing automated checks, you can self-reject the package.

If your package is failing automated testing, you can use the chocolatey test environment to manually run the verification and determine what may need to be fixed.

Note: We don't like to see packages automatically rejected. It doesn't mean that we don't value your contributions, just that we can not continue to hold packages versions in a waiting status that have possibly been abandoned. If you don't believe you will be able to fix up this version of the package within 15 days, we strongly urge you to log in to the site and respond to the review comments until you are able to.

chocolatey-ops (reviewer) on 12 Apr 2020 16:28:07 +00:00:

Unfortunately there has not been progress to move sandcastle v2020.3.6.0 towards an approved status within 15 days after the last review message, so we need to close (reject) the package version at this time. If you want to pick this version up and move it towards approval in the future, use the contact site admins link on the package page and we can move it back into a submitted status so you can submit updates.

Status Change - Changed status of package from 'submitted' to 'rejected'.

coldacid (maintainer) on 30 Sep 2020 15:07:22 +00:00:

I never saw the notifications that this was going to be rejected back in March/April, but from reviewing the logs it seems that the failure was a local MSI issue and unrelated to the package itself.
Auto Verification Change - Verification tests have been set to rerun.

gep13 (reviewer) on 01 Oct 2020 06:25:35 +00:00:

Status Change - Changed status of package from 'rejected' to 'submitted'.

coldacid (maintainer) on 05 Oct 2020 13:05:50 +00:00:

Package requires reverification as previous verification run failed through no fault of the package itself.

flcdrg (reviewer) on 06 Nov 2020 07:17:37 +00:00:

Rerun verification
Auto Verification Change - Verification tests have been set to rerun.

chocolatey-ops (reviewer) on 06 Nov 2020 07:22:50 +00:00:

Unfortunately there has not been progress to move sandcastle v2020.3.6.0 towards an approved status within 15 days after the last review message, so we need to close (reject) the package version at this time. If you want to pick this version up and move it towards approval in the future, use the contact site admins link on the package page and we can move it back into a submitted status so you can submit updates.

Status Change - Changed status of package from 'submitted' to 'rejected'.

Pauby (reviewer) on 07 Nov 2020 12:19:55 +00:00:

Status Change - Changed status of package from 'rejected' to 'submitted'.

flcdrg (reviewer) on 14 Nov 2020 01:54:46 +00:00:

Run verification tests again. It is odd as whilst at the top of the page it says there's an exemption check, but as a moderator when I look the exemption is not checked.

Let's see what this does

David
Auto Verification Change - Verification tests have been set to rerun.

chocolatey-ops (reviewer) on 16 Nov 2020 11:32:00 +00:00:

sandcastle has failed automated testing.
This is not the only check that is performed so check the package page to ensure a 'Ready' status.
Please visit https://gist.github.com/224dec6bcdc61378d22c5353e3ba5f15 for details.
The package status will be changed and will be waiting on your next actions.

  • NEW! We have a test environment for you to replicate the testing we do. This can be used at any time to test packages! See https://github.com/chocolatey/chocolatey-test-environment
  • Please log in and leave a review comment if you have questions and/or comments.
  • If you see the verifier needs to rerun testing against the package without resubmitting (a issue in the test results), you can do that on the package page in the review section.
  • If the verifier is incompatible with the package, please log in and leave a review comment if the package needs to bypass testing (e.g. package installs specific drivers).
  • Automated testing can also fail when a package is not completely silent or has pop ups (AutoHotKey can assist - a great example is the VeraCrypt package).
  • A package that cannot be made completely unattended should have the notSilent tag. Note that this must be approved by moderators.

coldacid (maintainer) on 16 Nov 2020 18:51:20 +00:00:

>ERROR: Running ["C:\Windows\System32\msiexec.exe" /i "C:\ProgramData\chocolatey\lib\sandcastle\tools\SHFBInstaller_v2020.3.6.0\InstallResources\SandcastleHelpFileBuilder.msi" /quiet ] was not successful. Exit code was '1603'. Exit code indicates the following: Generic MSI Error. This is a local environment error, not an issue with a package or the MSI itself - it could mean a pending reboot is necessary prior to install or something else (like the same version is already installed). Please see MSI log if available. If not, try again adding '--install-arguments="'/l*v c:\sandcastle_msi_install.log'"'. Then search the MSI Log for "Return Value 3" and look above that for the error..

Looks like the same problem as with the original test run, with the environment rather than the package. Could we get this package approved given there's no MSI log to check?

flcdrg (reviewer) on 20 Nov 2020 00:56:58 +00:00:

I ran up the chocolatey-test-environment and installed the package. Sure enough, it failed with the same error.

I then connected to the VM and ran the MSI interactively. It then failed with a more useful error:

"Sandcastle Help File Builder requires .NET Framework 4.7.2"

Given that, you should update the package dependencies to require https://chocolatey.org/packages/dotnet4.7.2

One that change is submitted, we can add a testing exemption

David

chocolatey-ops (reviewer) on 22 Nov 2020 12:22:51 +00:00:

Unfortunately there has not been progress to move sandcastle v2020.3.6.0 towards an approved status within 15 days after the last review message, so we need to close (reject) the package version at this time. If you want to pick this version up and move it towards approval in the future, use the contact site admins link on the package page and we can move it back into a submitted status so you can submit updates.

Status Change - Changed status of package from 'submitted' to 'rejected'.

Description

Sandcastle is composed of two separate parts that work together: the Sandcastle tools and the Sandcastle Help File Builder. The Sandcastle tools are used to create help files for managed class libraries containing both conceptual and API reference topics. API reference topics are created by combining the XML comments that are embedded in your source code with the syntax and structure of the types which is acquired by reflecting against the associated .NET Framework assemblies. Conceptual topics are created by converting XML documents that you author containing Microsoft Assistance Markup Language (MAML). The Sandcastle tools are command-line based and have no GUI front-end, project management features, or an automated build process.

The Sandcastle Help File Builder was created to fill in the gaps, provide the missing NDoc-like features that are used most often, and provide standalone GUI and command line based tools to build a help file in an automated fashion. A Visual Studio integration package is also available for it so that help projects can be created and managed entirely from within Visual Studio.


README.md
# Sandcastle Help File Builder and Tools

Sandcastle is composed of two separate parts that work together: the Sandcastle tools and the Sandcastle Help File Builder. The Sandcastle tools are used to create help files for managed class libraries containing both conceptual and API reference topics. API reference topics are created by combining the XML comments that are embedded in your source code with the syntax and structure of the types which is acquired by reflecting against the associated .NET Framework assemblies. Conceptual topics are created by converting XML documents that you author containing Microsoft Assistance Markup Language (MAML). The Sandcastle tools are command-line based and have no GUI front-end, project management features, or an automated build process.

The Sandcastle Help File Builder was created to fill in the gaps, provide the missing NDoc-like features that are used most often, and provide standalone GUI and command line based tools to build a help file in an automated fashion. A Visual Studio integration package is also available for it so that help projects can be created and managed entirely from within Visual Studio.
tools\chocolateyInstall.ps1
$toolsPath = Split-Path $MyInvocation.MyCommand.Definition
. $toolsPath\helpers.ps1

# stop on all errors
$ErrorActionPreference = 'Stop';

$packageName   = 'sandcastle' # arbitrary name for the package, used in messages
$versionNumber = '2020.3.6.0'
$url           = 'https://github.com/EWSoftware/SHFB/releases/download/v2020.3.6.0/SHFBInstaller_v2020.3.6.0.zip' # download url
$checksum      = 'cac7a5e3884fdf394c0970a196762ac72998b0bd4aa3a7f648fad97700b4e793'
$checksumType  = 'sha256'

$chocTempDir   = Join-Path $env:TEMP "chocolatey"
$tempDir       = Join-Path $chocTempDir "$packageName"

$zipFile = Join-Path $tempDir ('SHFBInstaller_v' + $versionNumber + '.zip')
$zipDir = Join-Path $toolsPath ('SHFBInstaller_v' + $versionNumber)

Get-ChocolateyWebFile "$packageName" "$zipFile" "$url" `
                      -Checksum "$checksum" -ChecksumType "$checksumType"
Get-ChocolateyUnzip "$zipFile" "$zipDir"

$packageArgs = @{
  packageName    = $packageName
  fileType       = 'MSI' # only one of these: exe, msi, msu
  file           = $(Join-Path $zipDir "InstallResources\SandcastleHelpFileBuilder.msi")

  silentArgs     = '/quiet'
  validExitCodes = @(0, 3010, 1641) # please insert other valid exit codes here, exit codes for ms http://msdn.microsoft.com/en-us/library/aa368542(VS.85).aspx
  softwareName   = 'Sandcastle*' #ensure this is the value in the registry
}
Install-ChocolateyInstallPackage @packageArgs

# Install-ChocolateyVsixPackage requires a URL, so build one out of the file path
$vsix = Join-Path $zipDir "InstallResources\SHFBVisualStudioPackage_VS2015AndLater.vsix"
$vsixUrl = "file:///" + $(Convert-Path $vsix).Replace("\", "/")

# Install-ChocolateyVsixPackage doesn't let us provide a list of supported versions for a package, unfortunately
# Check for each version supported by the Sandcastle tools VSIX and call the function repeatedly as needed
Get-VisualStudio | Where-Object { $_.installationVersion.Major -ge 14 } | ForEach-Object {
  $vsver = $_.installationVersion.ToString(2)
  Write-Host "Installing VSIX package for Visual Studio $vsver"

  if ( $_.installationVersion.Major -ge 15 ) {
    $vssku = Split-Path $_.installationPath -Leaf
    $vsixInstaller = Join-Path $_.installationPath 'Common7\IDE\VSIXInstaller.exe'

    # Otherwise VSIXInstaller.exe exits with error code 2003: NoApplicableSKUsException
    if ( $_.installationVersion.Major -eq 15 ) { $vsver = '15.0' }

    Write-Host "    SKU is '$vssku'"
    Write-Host "    Installation path is " $_.installationPath

    $exitCode = Install-VsixEXT "$vsixInstaller" "$vsix" "$vsver" "$vssku"
    if ($exitCode -eq 2004) { #2004: Blocking Process (need to close VS)
      throw "A process is blocking the installation of the Sandcastle extension for " + $_.displayName + ". Please close all instances and try again."
    }
    if ($exitCode -gt 0 -and $exitCode -ne 1001) { #1001: Already installed
      throw "There was an error installing the Sandcastle extension for " + $_.displayName + ". The exit code returned was $exitCode."
    }
  } elseif ( $_.installationVersion.Major -eq 14 ) {
    Install-ChocolateyVsixPackage "$packageName" "$vsixUrl" -VsVersion 14
  }
}

New-Item "$zipDir\SandcastleInstaller.exe.ignore" -Type file -Force | Out-Null
tools\helpers.ps1
function Get-VisualStudio {
  $versions = vswhere.exe -legacy -format json | ConvertFrom-Json
  $versions = $versions | Where-Object { ($_.installationPath -ne $null) -and (Test-Path $(Join-Path $_.installationPath 'Common7\IDE\devenv.exe')) }
  $versions | ForEach-Object {
    $_.installationVersion = [System.Version]($_.installationVersion)
    $_
  }
}

function Install-VsixEXT {
param(
  [parameter(Mandatory=$true, Position=0)] $installer,
  [parameter(Mandatory=$true, Position=1)] $installFile,
  [parameter(Mandatory=$true, Position=2)] $version = '15.0',
  [parameter(Mandatory=$true, Position=3)] $sku = 'Community',
  [parameter(ValueFromRemainingArguments = $true)][Object[]] $ignoredArguments
)

  # use original function for pre-2017
  if (([System.Version]$version).Major -lt 15) {
    return Install-Vsix "$installer" "$installFile"
  }

  Write-FunctionCallLogMessage -Invocation $MyInvocation -Parameters $PSBoundParameters

  if ($env:chocolateyPackageName -ne $null -and $env:chocolateyPackageName -eq $env:ChocolateyInstallDirectoryPackage) {
    Write-Warning "Install Directory override not available for VSIX packages."
  }

  Write-Host "Installing $installFile using $installer for Visual Studio $sku $version"
  $psi = New-Object System.Diagnostics.ProcessStartInfo
  $psi.FileName = $installer
  $psi.Arguments = "/q /v:$version /s:$sku $installFile"
  $s = [System.Diagnostics.Process]::Start($psi)
  $s.WaitForExit()

  return $s.ExitCode
}
update.ps1
Import-Module au
. $PSScriptRoot\..\_scripts\all.ps1

$domain =   'https://github.com'
$releases = "$domain/EWSoftware/SHFB/releases/latest"

function global:au_SearchReplace {
  @{
    ".\$($Latest.PackageName).nuspec" = @{
      "\<releaseNotes\>.+" = "<releaseNotes>$($Latest.ReleaseNotes)</releaseNotes>"
    }
    ".\tools\chocolateyInstall.ps1" = @{
      "(?i)(^\s*[$]packageName\s*=\s*)('.*')" = "`$1'$($Latest.PackageName)'"
      "(?i)(^\s*[$]versionNumber\s*=\s*)('.*')" = "`$1'$($Latest.Version)'"
      "(?i)(^\s*[$]url\s*=\s*)('.*')" = "`$1'$($Latest.URL32)'"
      "(?i)(^\s*[$]checksum\s*=\s*)('.*')" = "`$1'$($Latest.Checksum32)'"
      "(?i)(^\s*[$]checksumType\s*=\s*)('.*')" = "`$1'$($Latest.ChecksumType32)'"
    }
  }
}

function global:au_GetLatest {
  $download_page = Invoke-WebRequest -Uri $releases -UseBasicParsing
  $regex   = 'SHFBInstaller_v.*\.zip$'
  $url    = $download_page.links | Where-Object href -Match $regex | Select-Object -First 1 -Expand href
  $version = $url -split '_v|.zip' | Select-Object -Last 1 -Skip 1

  $url32 = $domain + $url

  $releaseNotesUrl = "$domain/EWSoftware/SHFB/releases/tag/v" + $version

  return @{
    Version = $version

    URL32 = $url32

    ReleaseNotes = $releaseNotesUrl
  }
}

Update-Package

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
Sandcastle Help File Builder and Tools (Install) 2019.9.15.0 319 Thursday, September 19, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.8.24.0 119 Thursday, September 12, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.6.24.0 436 Wednesday, June 26, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.4.14.0 267 Friday, April 19, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.4.7.0 101 Friday, April 12, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.3.31.0 152 Monday, April 1, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2018.12.10.0 321 Saturday, December 15, 2018 Approved
Sandcastle Help File Builder and Tools (Install) 2018.7.8.0 547 Tuesday, July 24, 2018 Approved

Discussion for the Sandcastle Help File Builder and Tools (Install) Package

Ground Rules:

  • This discussion is only about Sandcastle Help File Builder and Tools (Install) and the Sandcastle Help File Builder and Tools (Install) package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Sandcastle Help File Builder and Tools (Install), or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus