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

Explain we don't want MD5 checksums for versions.yml #1823

Merged
merged 4 commits into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions markdown/developers/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ We have implemented a number of commands in the `nf-core/tools` package to make

`md5sum` checks are the preferable choice of test to determine file changes, however, this may not be possible for all outputs generated by some tools e.g. if they include time stamps or command-related headers. Please do your best to avoid just checking for the file being present e.g. it may still be possible to check that the file contains the appropriate text snippets.

> Leave the `versions.yml` entry _without_ a MD5 checksum. Its content will change every time we bump the version of the software.

8. Create a yaml file containing information required for module unit testing

```console
Expand Down
2 changes: 1 addition & 1 deletion public_html/assets/js/aws-s3-explorer.js
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ $(function () {
if (data.params.Prefix) {
parts.push.apply(
parts,
data.params.Prefix.endsWith('/') ? data.params.Prefix.slice(0, -1).split('/') : data.params.Prefix.split('/')
data.params.Prefix.endsWith('/') ? data.params.Prefix.slice(0, -1).split('/') : data.params.Prefix.split('/'),
);
}

Expand Down
24 changes: 12 additions & 12 deletions public_html/assets/js/canvas2svg.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
'Scaron,b1,scaron,bo,Yuml,m6,circ,ms,tilde,802,ensp,803,emsp,809,thinsp,80c,zwnj,80d,zwj,80e,lrm,' +
'80f,rlm,80j,ndash,80k,mdash,80o,lsquo,80p,rsquo,80q,sbquo,80s,ldquo,80t,rdquo,80u,bdquo,810,dagger,' +
'811,Dagger,81g,permil,81p,lsaquo,81q,rsaquo,85c,euro',
32
32,
);

//Some basic mappings for attributes and default values.
Expand Down Expand Up @@ -415,7 +415,7 @@
matches = regex.exec(value);
currentElement.setAttribute(
style.svgAttr,
format('rgb({r},{g},{b})', { r: matches[1], g: matches[2], b: matches[3] })
format('rgb({r},{g},{b})', { r: matches[1], g: matches[2], b: matches[3] }),
);
//should take globalAlpha here
var opacity = matches[4];
Expand Down Expand Up @@ -671,7 +671,7 @@
cp2y: cp2y,
x: x,
y: y,
})
}),
);
};

Expand Down Expand Up @@ -823,7 +823,7 @@
width: width,
height: height,
},
true
true,
);
parent = this.__closestGroupOrSvg();
parent.appendChild(rect);
Expand All @@ -848,7 +848,7 @@
width: width,
height: height,
},
true
true,
);
parent = this.__closestGroupOrSvg();
parent.appendChild(rect);
Expand Down Expand Up @@ -899,7 +899,7 @@
height: height,
fill: '#FFFFFF',
},
true
true,
);
parent.appendChild(rect);
};
Expand All @@ -919,7 +919,7 @@
y2: y2 + 'px',
gradientUnits: 'userSpaceOnUse',
},
false
false,
);
this.__defs.appendChild(grad);
return new CanvasGradient(grad, this);
Expand All @@ -941,7 +941,7 @@
fy: y0 + 'px',
gradientUnits: 'userSpaceOnUse',
},
false
false,
);
this.__defs.appendChild(grad);
return new CanvasGradient(grad, this);
Expand Down Expand Up @@ -1018,7 +1018,7 @@
'text-anchor': getTextAnchor(this.textAlign),
'dominant-baseline': getDominantBaseline(this.textBaseline),
},
true
true,
);

textElement.appendChild(this.__document.createTextNode(text));
Expand Down Expand Up @@ -1100,7 +1100,7 @@
sweepFlag: sweepFlag,
endX: endX,
endY: endY,
})
}),
);

this.__currentPosition = { x: endX, y: endY };
Expand Down Expand Up @@ -1234,7 +1234,7 @@
svgImage.setAttributeNS(
'http://www.w3.org/1999/xlink',
'xlink:href',
image.nodeName === 'CANVAS' ? image.toDataURL() : image.getAttribute('src')
image.nodeName === 'CANVAS' ? image.toDataURL() : image.getAttribute('src'),
);
parent.appendChild(svgImage);
}
Expand All @@ -1257,7 +1257,7 @@
img.setAttributeNS(
'http://www.w3.org/1999/xlink',
'xlink:href',
image.nodeName === 'CANVAS' ? image.toDataURL() : image.getAttribute('src')
image.nodeName === 'CANVAS' ? image.toDataURL() : image.getAttribute('src'),
);
pattern.appendChild(img);
this.__defs.appendChild(pattern);
Expand Down
26 changes: 13 additions & 13 deletions public_html/assets/js/nf-core-schema-builder.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ $(function () {
.calendar()
.replace(/^\w/, function (chr) {
return chr.toLowerCase();
})
}),
);
$('.cache_expires_at').show();

Expand Down Expand Up @@ -105,7 +105,7 @@ $(function () {
search_term +
"'], .popover-body div button[data-classname*='" +
search_term +
"']"
"']",
)
.show();
}
Expand Down Expand Up @@ -294,14 +294,14 @@ $(function () {
} else {
$('.add-param-btn, .add-group-btn, .collapse-groups-btn, .expand-groups-btn, .to-top-btn').attr(
'disabled',
false
false,
);
}

// Warn about the console finishing
if ($(this).hasClass('back-to-editor-btn')) {
alert(
'nf-core schema build will have now exited. Any further change will have to be manually copied to your schema file. Note that you can run nf-core schema build as often as you like for updates.'
'nf-core schema build will have now exited. Any further change will have to be manually copied to your schema file. Note that you can run nf-core schema build as often as you like for updates.',
);
}
});
Expand Down Expand Up @@ -776,7 +776,7 @@ $(function () {
var help_text_html = md_converter.makeHtml($('#help_text_input').val());
$('.helptext-html-preview .helptext-preview-helptext').html(help_text_html);
$('.helptext-html-preview .helptext-preview-helptext table').addClass(
'table table-bordered table-striped table-sm small'
'table table-bordered table-striped table-sm small',
);
$('.helptext-html-preview .helptext-preview-helptext table').wrap('<div class="table-responsive"></div>');
}
Expand Down Expand Up @@ -937,7 +937,7 @@ $(function () {
var number_val = parseFloat(el);
if (isNaN(number_val)) {
$('.modal-body').append(
'<div class="alert alert-danger">Error: Enumerated values have to be numeric for parameter types "integer" and "number".</div>'
'<div class="alert alert-danger">Error: Enumerated values have to be numeric for parameter types "integer" and "number".</div>',
);
e.preventDefault();
e.stopPropagation();
Expand Down Expand Up @@ -1324,10 +1324,10 @@ function generate_param_row(id, param) {
var re = new RegExp('^fa[a-z -]+$');
if (!re.test(param['fa_icon'])) {
console.error(
"FontAwesome icon did not match the regex: /^fa[a-z -]+$/ ('" + param['fa_icon'] + "') - removing from schema."
"FontAwesome icon did not match the regex: /^fa[a-z -]+$/ ('" + param['fa_icon'] + "') - removing from schema.",
);
alert(
"FontAwesome icon did not match the regex: /^fa[a-z -]+$/ ('" + param['fa_icon'] + "') - removing from schema."
"FontAwesome icon did not match the regex: /^fa[a-z -]+$/ ('" + param['fa_icon'] + "') - removing from schema.",
);
delete param['fa_icon'];
update_param_in_schema(id, param);
Expand Down Expand Up @@ -1438,7 +1438,7 @@ function generate_group_row(id, param, child_params) {
var re = new RegExp('^fa[a-z -]+$');
if (!re.test(param['fa_icon'])) {
console.error(
"FontAwesome icon did not match the regex: /^fa[a-z -]+$/ ('" + param['fa_icon'] + "') - removing from schema."
"FontAwesome icon did not match the regex: /^fa[a-z -]+$/ ('" + param['fa_icon'] + "') - removing from schema.",
);
delete param['fa_icon'];
update_param_in_schema(id, param);
Expand Down Expand Up @@ -1622,7 +1622,7 @@ function validate_param(param) {
'Error: Default value "' +
param['default'] +
'" must be greater than or equal to minimum value: ' +
param['minimum']
param['minimum'],
);
return false;
}
Expand All @@ -1633,7 +1633,7 @@ function validate_param(param) {
'Error: Default value "' +
param['default'] +
'" must be less than or equal to maximum value: ' +
param['maximum']
param['maximum'],
);
return false;
}
Expand Down Expand Up @@ -1670,7 +1670,7 @@ function validate_param(param) {
'Error: Default value "' +
param['default'] +
'" must be one of the Enumerated values: ' +
param['enum'].join(', ')
param['enum'].join(', '),
);
return false;
}
Expand All @@ -1681,7 +1681,7 @@ function validate_param(param) {
var re = new RegExp(param['pattern']);
if (!re.test(param['default'])) {
alert(
'Error: Default value "' + param['default'] + '" must match the parameter pattern regex: ' + param['pattern']
'Error: Default value "' + param['default'] + '" must match the parameter pattern regex: ' + param['pattern'],
);
return false;
}
Expand Down
6 changes: 3 additions & 3 deletions public_html/assets/js/nf-core-schema-launcher.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ $(function () {
.calendar()
.replace(/^\w/, function (chr) {
return chr.toLowerCase();
})
}),
);
$('.cache_expires_at').show();

Expand Down Expand Up @@ -120,7 +120,7 @@ function set_validation_styles(form_is_valid) {
// Reset
$('#validation_fail_list').html('');
$('.form-control:has(.form-check-input[type="radio"])').removeClass(
'radio-form-control-valid radio-form-control-invalid'
'radio-form-control-valid radio-form-control-invalid',
);
$('.input-group .input-group-prepend').removeClass('input-group-valid input-group-invalid');

Expand All @@ -141,7 +141,7 @@ function set_validation_styles(form_is_valid) {
$(this).attr('id') +
'" class="scroll_to_link"><code>' +
$(this).attr('name').replace('params_', '--').replace('nxf_flag_', '') +
'</code></a></li>'
'</code></a></li>',
);
});
}
Expand Down
4 changes: 2 additions & 2 deletions public_html/assets/js/nf-core.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ $(function () {
let $this = $(this);
$this.addClass('position-relative');
var $copy_btn = $(
'<button class="btn btn-outline-secondary copy-button position-absolute top-0 end-0" data-bs-toggle="tooltip" data-bs-placement="left" data-bs-original-title="Copy to clipboard" ><i class="fas fa-clipboard fa-swap-opacity"></i></button>'
'<button class="btn btn-outline-secondary copy-button position-absolute top-0 end-0" data-bs-toggle="tooltip" data-bs-placement="left" data-bs-original-title="Copy to clipboard" ><i class="fas fa-clipboard fa-swap-opacity"></i></button>',
);
$this.append($copy_btn);
var btn_tooltip = new bootstrap.Tooltip($copy_btn, { container: 'body' });
Expand Down Expand Up @@ -493,6 +493,6 @@ function scroll_to(target_el, offset) {
{
scrollTop: el_offset,
},
500
500,
);
}
2 changes: 1 addition & 1 deletion public_html/assets/js/transcripts.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ function highlight(event) {
$('details[open]').scrollTop() -
1.2 * parseFloat(getComputedStyle(document.documentElement).fontSize), // convert rem into px
},
'slow'
'slow',
);
}
}
Expand Down
8 changes: 6 additions & 2 deletions public_html/assets/scss/_nf-core.scss
Original file line number Diff line number Diff line change
Expand Up @@ -568,8 +568,12 @@ h4:focus .header-link,

.edit-md-btn {
opacity: 0.5;
transition: opacity 0.15s ease-in-out, color 0.15s ease-in-out, background-color 0.15s ease-in-out,
border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out;
transition:
opacity 0.15s ease-in-out,
color 0.15s ease-in-out,
background-color 0.15s ease-in-out,
border-color 0.15s ease-in-out,
box-shadow 0.15s ease-in-out;
}
.edit-md-btn:hover,
.edit-md-btn:active,
Expand Down